imas-simdb 0.13.0__tar.gz

imas_simdb-0.13.0/.gitattributes

@@ -0,0 +1 @@
+src/simdb/_version.py export-subst

imas_simdb-0.13.0/.github/workflows/build_and_test.yml

@@ -0,0 +1,53 @@
+name: SimDB CI
+
+on: 
+    push:
+    pull_request:
+      types: [opened, synchronize, reopened]
+  
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ "3.11", "3.12", "3.13" ]
+
+    steps:
+      - name: Install OpenLDAP development libraries
+        run: sudo apt-get update && sudo apt-get install -y libldap2-dev libsasl2-dev
+      
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+            python-version: ${{ matrix.python-version }}
+            cache: pip
+
+      - name: Install build and test dependencies
+        run: |
+          python -m venv venv
+          source venv/bin/activate
+          pip install --upgrade pip setuptools wheel
+          python -m pip install python-ldap
+          pip install pytest-xdist
+          pip install .[build-test]
+
+      - name: Run tests
+        run: |
+          source venv/bin/activate
+          python -m pytest --cov=simdb --cov-report=term-missing --cov-report=xml:coverage.xml --cov-report=html:htmlcov --junit-xml=junit.xml -v --tb=short
+
+      - name: Upload coverage report ${{ matrix.python-version }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report-${{ matrix.python-version }}
+          path: htmlcov
+
+      - name: Upload test report ${{ matrix.python-version }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-report-${{ matrix.python-version }}
+          path: junit.xml

imas_simdb-0.13.0/.github/workflows/build_docs.yml

@@ -0,0 +1,50 @@
+name: Build Docs
+
+on: 
+    push:
+    pull_request:
+      types: [opened, synchronize, reopened]
+      paths:
+      - "docs/**" 
+      - "src/simdb/**"
+  
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest    
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+          cache: pip
+      
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip setuptools wheel
+          pip install .[build-docs]
+
+      - name: Build Documentation
+        run: |
+          cd docs
+          sphinx-apidoc -f -o sphinx -e -M ../src/simdb
+          rm -f sphinx/modules.rst || true
+          cp -f *.md sphinx/ 2>/dev/null || true
+          cp -f *.svg sphinx/ 2>/dev/null || true
+          make clean html
+
+      - name: Upload docs artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: documentation
+          path: docs/_build/html
+
+      - name: Check build warnings
+        run: |
+          if grep -q "WARNING\|ERROR" docs/_build/html/.doctrees/environment.pickle 2>/dev/null; then
+            echo "Documentation build has warnings/errors"
+            exit 1
+          fi
+          

imas_simdb-0.13.0/.github/workflows/publish.yml

@@ -0,0 +1,70 @@
+name: build-wheel-and-publish-test-pypi
+
+on:
+  push:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-22.04
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0 
+    - name: Set up Python
+      uses: actions/setup-python@v5
+    - 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 SimDB distribution to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-22.04
+    environment:
+      name: pypi
+      url: https://pypi.org/p/imas-simdb
+    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 SimDB distribution to TestPyPI
+    if: github.ref=='refs/heads/develop'  # only publish to TestPyPI on develop pushes
+    needs:
+    - build
+    runs-on: ubuntu-22.04
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/imas-simdb
+    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

imas_simdb-0.13.0/.gitignore

@@ -0,0 +1,33 @@
+__pycache__
+sql/sim.db
+.idea/
+.mypy_cache
+/build
+/data
+/logs
+venv
+environment.txt
+environment.yml
+git_update
+runtests
+sdb
+src/simdb/cli/runtests
+src/simdb.egg-info
+test.yml
+test4_manifest.yml
+test7_manifest.yml
+test_manifest.yml
+/temp
+/htmlcov
+/test-reports/
+/tests/cli/test.cfg
+/tests/cli/*.yaml
+.eggs
+.coverage
+*.xml
+simdb-coverage-report
+*.tar.gz
+src/simdb/_version.py
+*.egg-info
+*.egg
+*.whl

imas_simdb-0.13.0/.gitlab-ci.yml

@@ -0,0 +1,148 @@
+image:
+   name: "python:3.7"
+
+stages:
+  - build
+  - test
+  - doc
+
+# Change pip's cache directory to be inside the project directory since we can
+# only cache local items.
+variables:
+    PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
+    PYTHONTOOLS_VENV_PATH: "$CI_PROJECT_DIR/venv/simdb"
+    PYTHONTOOLS_DIR: "$CI_PROJECT_DIR"
+    PACKAGE: "simdb"
+
+# Pip's cache doesn't store the python packages
+# https://pip.pypa.io/en/stable/reference/pip_install/#caching
+#
+# If you want to also cache the installed packages, you have to install
+# them in a virtualenv and cache it as well.
+.cache_python: &cache_python
+  paths:
+    - $PIP_CACHE_DIR
+
+
+########################################
+# General Docker environment templates #
+########################################
+
+##############################
+# Global tests and templates #
+##############################
+before_script:
+  - export USER=root
+
+.collect_deps_manually: &collect_deps_manually |
+  export BUILD_DEPS=$(cat pyproject.toml | grep requires | cut -d'=' -f2- | tr -d ,\"\' | sed "s/^ \[//" | sed "s/\]$//")
+  export RUN_DEP_FILES=dev_requirements.txt
+
+.print_debugging: &print_debugging |
+  python --version # Print out python version for debugging
+  pip --version # Show pip version for debugging
+  echo $PYTHONPATH
+  echo $PATH
+  echo BUILD_DEPS=$BUILD_DEPS
+  echo RUN_DEP_FILES=$RUN_DEP_FILES
+
+# venv editable install
+.install_venv_editable_template:
+  script:
+    - *collect_deps_manually
+    - *print_debugging
+      # Now we install dependencies manually
+    - pip install --upgrade $BUILD_DEPS # Install build deps manually
+    - python setup.py --version # Print setuptools found version
+    - python -m pip freeze > $PYTHONTOOLS_DIR/pre_install_packages.txt
+    - for file in $RUN_DEP_FILES; do echo Installing $file; pip install -r $file; done; # Install run deps manually
+      # Install from wheel
+      # Should install almost nothing, as we installed most of it ourselves
+      # Install without extras here. We installed these manually.
+    - pip install ---no-build-isolation --upgrade --editable . # Install local folder in editable mode
+    - pip freeze > $PYTHONTOOLS_DIR/post_install_packages.txt
+      # Do basic sanity checking
+    - mkdir tmp && cd tmp
+    - python -c "import $PACKAGE; print($PACKAGE.__version__); print($PACKAGE.__path__)" # Try regular import
+      # Run the real test, pytest
+    - which pytest
+    - pytest --version
+    - echo Running "pytest --cov=$PACKAGE --cov-report=term --cov-report=xml:$PYTHONTOOLS_DIR/coverage.xml --junit-xml=$PYTHONTOOLS_DIR/junit.xml --ignore=../tests/NNDB '"$PYTHONTOOLS_DIR"'"
+    - pytest --cov=$PACKAGE --cov-report=term --cov-report=xml:$PYTHONTOOLS_DIR/coverage.xml --junit-xml=$PYTHONTOOLS_DIR/junit.xml "$PYTHONTOOLS_DIR"
+  # One pipeline has one artifact. We need both the test report _and_ the installed packages to pass on
+  artifacts:
+    name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME"
+    reports:
+      junit: [$PYTHONTOOLS_DIR/junit.xml]
+      cobertura: [$PYTHONTOOLS_DIR/coverage.xml]
+    when: always
+    expire_in: 1 day # These are only used in quick interactive CI debugging, and in next jobs
+  stage: test
+  cache:
+    <<: *cache_python
+    policy: push
+  needs: [] # Only needs a sane python env
+
+# editable venv-like install
+install_venv_editable:
+  extends: .install_venv_editable_template
+
+flake8:
+  stage: test
+  before_script:
+    - pip install flake8 pyflakes anybadge
+  script:
+    - mkdir -p ./flake8
+    - flake8 --exit-zero --doctests --statistics --count $(find $PACKAGE -name '*.py') | tee flake8.txt
+    - PEP8_VIOLATIONS=$(tail flake8.txt -n1)
+    - echo "Flake8 finds $PEP8_VIOLATIONS PEP8 violations"
+    - anybadge -ou --label=flake8 --value=$PEP8_VIOLATIONS --file=flake8/flake8.svg -c silver
+  artifacts:
+    paths:
+      - ./flake8/
+
+pylint:
+  stage: test
+  before_script:
+    - pip install pylint pylint-exit anybadge
+  script:
+    - mkdir -p ./pylint
+    - pylint --rcfile=.pylintrc --output-format=text src | tee ./pylint/pylint.log || pylint-exit $?
+    - PYLINT_SCORE=$(sed -n 's/^Your code has been rated at \([-0-9.]*\)\/.*/\1/p' ./pylint/pylint.log)
+    - echo "Pylint score is $PYLINT_SCORE"
+    - anybadge -ou --label=pylint --value=$PYLINT_SCORE --file=pylint/pylint.svg 2=red 4=orange 8=yellow 10=green
+  artifacts:
+    paths:
+      - ./pylint/
+
+black:
+  stage: test
+  script:
+    - pip install black
+    - black --diff --color src
+
+pages:
+  stage: doc
+  script:
+    - pip install -r dev_requirements.txt
+    - pip install --upgrade --editable .
+    - cd docs
+    - sphinx-apidoc -f -o sphinx -e -M ../src/simdb && rm sphinx/modules.rst
+    - cp *.md sphinx
+    - cp *.svg sphinx
+    - make clean
+    - make html
+    - mv _build/html/ ../public/
+  artifacts:
+    paths:
+      - public/
+      - docs/_build/
+      - docs/source/generated/
+  only:
+      - master
+      - /^release.*$/
+      - feature/ukaea-gitlab-ci
+  cache:
+    <<: *cache_python
+    policy: pull
+  needs: ["install_venv_editable"]

imas_simdb-0.13.0/.readthedocs.yml

@@ -0,0 +1,24 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+  jobs:
+    post_checkout:
+      - git fetch --unshallow || true
+      - cp docs/*.md docs/sphinx/ || true
+    pre_build:
+      - cd docs && sphinx-apidoc -f -o sphinx -e -M ../src/simdb
+    
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - build-docs
+
+sphinx:
+  builder: html
+  configuration: docs/sphinx/conf.py
+  fail_on_warning: false

imas_simdb-0.13.0/Dockerfile

@@ -0,0 +1,9 @@
+FROM python:3.7
+COPY ./ /tmp/simdb/
+RUN cd /tmp/simdb/ && \
+    pip3 install . && \
+    pip3 install flask flask_caching flask_cors flask_restx gunicorn psycopg2-binary && \
+    rm -rf /tmp/simdb
+
+ENTRYPOINT ["gunicorn", "--bind=0.0.0.0:5000", "--workers=1", "simdb.remote.wsgi:app"]
+EXPOSE 5000

imas_simdb-0.13.0/LICENSE.txt

@@ -0,0 +1,165 @@
+                  GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

imas_simdb-0.13.0/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: imas-simdb
+Version: 0.13.0
+Summary: ITER Simulation Management Tool
+Author: ITER Organization
+Author-email: imas-support@iter.org
+Maintainer: ITER Organization
+Maintainer-email: imas-support@iter.org
+Project-URL: Homepage, https://simdb.iter.org/dashboard/
+Project-URL: Documentation, https://sharepoint.iter.org/departments/POP/CM/IMDesign/Code%20Documentation/simdb-doc/html/index.html
+Project-URL: Repository, https://git.iter.org/projects/IMEX/repos/simdb/browse
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: System Administrators
+Classifier: Natural Language :: English
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: Cerberus>=1.3.2
+Requires-Dist: PyJWT>=1.4.0
+Requires-Dist: appdirs>=1.4
+Requires-Dist: appdirs>=1.4.0
+Requires-Dist: argcomplete>=1.9.4
+Requires-Dist: backports-datetime-fromisoformat>=1.0
+Requires-Dist: click<=8.1.8,>=7.0
+Requires-Dist: click_option_group>=0.5
+Requires-Dist: distro>=1.8.0
+Requires-Dist: email-validator>=1.1
+Requires-Dist: numpy>=1.14
+Requires-Dist: python-dateutil>=2.6
+Requires-Dist: pyyaml>=3.13
+Requires-Dist: requests>=2.27.0
+Requires-Dist: semantic-version>=2.8
+Requires-Dist: sqlalchemy<2.0,>=1.2.12
+Requires-Dist: urllib3>=1.26
+Provides-Extra: build-test
+Requires-Dist: pytest>=6.0; extra == "build-test"
+Requires-Dist: pytest-cov>=2.0; extra == "build-test"
+Requires-Dist: mypy>=0.910; extra == "build-test"
+Requires-Dist: flake8>=3.9; extra == "build-test"
+Requires-Dist: tox>=3.24; extra == "build-test"
+Requires-Dist: Flask>=2.0; extra == "build-test"
+Requires-Dist: flask-cors>=3; extra == "build-test"
+Requires-Dist: flask-compress>=1.12; extra == "build-test"
+Requires-Dist: Werkzeug==2.0.3; extra == "build-test"
+Requires-Dist: python-magic~=0.4; extra == "build-test"
+Requires-Dist: flask-caching>=1.10; extra == "build-test"
+Requires-Dist: flask-restx==0.5; extra == "build-test"
+Requires-Dist: flask-mail~=0.9.1; extra == "build-test"
+Requires-Dist: simplejson~=3.0; extra == "build-test"
+Requires-Dist: easyad>=1.0; extra == "build-test"
+Provides-Extra: server
+Requires-Dist: Flask>=2.0; extra == "server"
+Requires-Dist: Werkzeug==2.0.3; extra == "server"
+Requires-Dist: flask-caching>=1.10; extra == "server"
+Requires-Dist: flask-compress>=1.12; extra == "server"
+Requires-Dist: flask-cors>=3; extra == "server"
+Requires-Dist: flask-mail~=0.9.1; extra == "server"
+Requires-Dist: flask-restx==0.5; extra == "server"
+Requires-Dist: python-magic~=0.4; extra == "server"
+Requires-Dist: simplejson~=3.0; extra == "server"
+Provides-Extra: auth-ad
+Requires-Dist: easyad>=1.0; extra == "auth-ad"
+Provides-Extra: auth-keycloak
+Requires-Dist: python-keycloak>=4.0; extra == "auth-keycloak"
+Provides-Extra: auth-ldap
+Requires-Dist: python-ldap>=3.4; extra == "auth-ldap"
+Provides-Extra: imas-validator
+Requires-Dist: imas-validator>=1.0.0; extra == "imas-validator"
+Provides-Extra: build-docs
+Requires-Dist: sphinx>=4.5; extra == "build-docs"
+Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "build-docs"
+Requires-Dist: sphinx-autodoc-typehints>=1.12.0; extra == "build-docs"
+Requires-Dist: myst-parser>=0.18.0; extra == "build-docs"
+Requires-Dist: nbsphinx>=0.8.0; extra == "build-docs"
+Requires-Dist: docutils>=0.17; extra == "build-docs"
+Requires-Dist: recommonmark>=0.7.0; extra == "build-docs"
+Provides-Extra: postgres
+Requires-Dist: psycopg2-binary>=2.8.0; extra == "postgres"
+Provides-Extra: all
+Requires-Dist: simdb[imas-validator,postgres,server]; extra == "all"
+Dynamic: license-file
+
+# SimDB simulation management tool
+
+SimDB is a tool designed to track, manage, upload and query simulations. The simulation data can be tagged with metadata, managed locally or transferred to remote SimDB services. Uploaded simulations can then be queried based on metadata.
+
+## Command line interface
+
+SimDB consists of a command line interface (CLI) tool which interacts with one or more remote services.
+
+For details on how to install the CLI see [here](docs/install_guide.md) and for information on how to use the CLI see [here](docs/user_guide.md).
+
+### Accessing ITER remotes
+
+To access data from the ITER remotes from outside of the ITER systems you'll need to [add and configure a SimDB remote](docs/iter_remotes.md).
+
+### Installing ITER certificate
+
+To access the ITER remote from within the ITER systems you will need to install the ITER SSL certificate. Details for how to do this can be found [here](docs/iter_certificate.md).
+
+## Server setup
+
+For information on setting and maintaining a remote CLI server see [here](docs/maintenance_guide.md).
+
+## Developer guide
+
+Information about setting up a developer environment can be found [here](docs/developer_guide.md).