Merge pull request #14 from iterorganization/rename_imaspy_sources_to_imas

Rename imaspy sources to imas

Author: olivhoenen

.git_archival.txt

@@ -0,0 +1,3 @@
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$

.gitattributes

@@ -1 +1 @@
-imaspy/_version.py export-subst
+.git_archival.txt export-subst

.github/workflows/linting.yml

@@ -0,0 +1,29 @@
+name: linting-and-code-formatting
+
+on: push
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout IMAS-Python sources
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+
+      - name: Install the code linting and formatting tools
+        run: pip install --upgrade 'black >=24,<25' flake8
+
+      - name: Check formatting of code with black
+        run: black --check imas
+
+      - name: Check linting with flake8
+        run: flake8 imas

.github/workflows/publish.yml

@@ -0,0 +1,67 @@
+name: build-wheel-and-publish-test-pypi
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0 
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m pip install pip setuptools wheel build
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build .
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+        
+  publish-to-pypi:
+    name: Publish IMAS-Python distribution to PyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/imas-python
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      
+  publish-to-testpypi:
+    name: Publish IMAS-Python distribution to TestPyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/imas-python
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to TestPyPI
+      uses: pypa/gh-action-pypi-publish@unstable/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/
+        verbose: true

.gitignore

@@ -91,21 +91,16 @@ ENV/
 *.swo
 
 # SCM setuptools
-imaspy/version.py
-
-# Saxon symlink or downloaded file
-saxon*.jar
+imas/_version.py
 
 # IMAS DD
 data-dictionary
-access-layer
-containers/arch/imaspy/
+containers/arch/imas/
 containers/arch/data-dictionary/
-containers/arch/access-layer/
-imaspy/assets/IDSDef.zip
+imas/assets/IDSDef.zip
 
 # IDS files
-*.ids
+# *.ids
 
 # ASV folder
 /.asv

.readthedocs.yml

@@ -0,0 +1,23 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+  jobs:
+    post_checkout:
+      - git fetch --unshallow || true
+    
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+        - netcdf
+        - h5py
+
+sphinx:
+  builder: html
+  configuration: docs/source/conf.py
+  fail_on_warning: false

CONTRIBUTING.md

@@ -1,23 +1,23 @@
 # Contributing guidelines
 
-We welcome any kind of contribution to `imas-python`, 
+We welcome any kind of contribution to `IMAS-Python`, 
 from a simple comment, a question or even a full fledged pull 
 request. 
 Please first make sure you read and follow the 
 [Code of Conduct](CODE_OF_CONDUCT.md).
 
 ## You think you found a bug in the code, or have a question in its use
-1. use the [issue search](https://github.com/iterorganization/imas-python/issues)
+1. use the [issue search](https://github.com/iterorganization/IMAS-Python/issues)
 to check if someone already created a similar issue;
 3. if not, make a **new issue** to describe your problem or question. 
 In the case of a bug suspiscion, please try to give all the relevant 
 information to allow reproducing the error or identifying 
-its root cause (version of the imas-python, OS and relevant 
+its root cause (version of the IMAS-Python, OS and relevant 
 dependencies, snippet of code);
 4. apply relevant labels to the issue.
 
 ## You want to make or ask some change to the code
-1. use the [issue search](https://github.com/iterorganization/imas-python/issues)
+1. use the [issue search](https://github.com/iterorganization/IMAS-Python/issues)
 to check if someone already proposed a similar idea/change;
 3. if not, create a **new issue** to describe what change you would like to see 
 implemented and specify it if you intend to work on it yourself or if some help 

MANIFEST.in

@@ -1,6 +1,6 @@
-include imaspy/assets/IDSDef.zip
-include imaspy/assets/IDSDef2MDSpreTree.xsl
-include imaspy/assets/ITER_134173_106_equilibrium.ids
-include imaspy/assets/ITER_134173_106_core_profiles.ids
-include imaspy/assets/equilibrium.ids
-include imaspy/assets/core_profiles.ids
+include imas/assets/IDSDef.zip
+include imas/assets/IDSDef2MDSpreTree.xsl
+include imas/assets/ITER_134173_106_equilibrium.ids
+include imas/assets/ITER_134173_106_core_profiles.ids
+include imas/assets/equilibrium.ids
+include imas/assets/core_profiles.ids

README.md

@@ -11,7 +11,7 @@ Data Model.
 Install steps are described in the documentation generated from `/docs/source/installing.rst`.
 
 Documentation is autogenerated from the source using [Sphinx](http://sphinx-doc.org/)
-and can be found at the [ITER sharepoint](https://sharepoint.iter.org/departments/POP/CM/IMDesign/Code%20Documentation/IMAS-doc/index.html)
+and can be found at the [readthedocs](https://imas-python.readthedocs.io/en/latest/)
 
 The documentation can be manually generated by installing sphinx and running:
 
@@ -40,7 +40,7 @@ A quick 5 minutes introduction is available in the documentation generated from
 
 ## Legal
 
-IMAS-Python is Copyright 2020-2024 ITER Organization, Copyright 2020-2023 Karel Lucas van de 
+IMAS-Python is Copyright 2020-2025 ITER Organization, Copyright 2020-2023 Karel Lucas van de 
 Plassche <[email protected]>, Copyright 2020-2022 Daan van Vugt <[email protected]>,
 and Copyright 2020 Dutch Institute for Fundamental Energy Research <[email protected]>.
 It is licensed under [LGPL 3.0](LICENSE.txt).

asv.conf.json

@@ -4,10 +4,10 @@
     "version": 1,
 
     // The name of the project being benchmarked
-    "project": "imaspy",
+    "project": "imas",
 
     // The project's homepage
-    "project_url": "https://git.iter.org/projects/IMAS/repos/imaspy/browse",
+    "project_url": "https://github.com/iterorganization/IMAS-Python",
 
     // The URL or local path of the source code repository for the
     // project being benchmarked
@@ -53,7 +53,7 @@
     //"install_timeout": 600,
 
     // the base URL to show a commit for the project.
-    "show_commit_url": "https://git.iter.org/projects/IMAS/repos/imaspy/commits/",
+    "show_commit_url": "https://github.com/iterorganization/IMAS-Python/commits/main/",
 
     // The Pythons you'd like to test against.  If not provided, defaults
     // to the current version of Python used to run `asv`.