Metadata-Version: 2.4
Name: imas-simdb
Version: 0.14.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://simdb.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/iterorganization/SimDB
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
Requires-Dist: imas-python
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](https://simdb.readthedocs.io/en/stable/install_guide.html) and for information on how to use the CLI see [here](https://simdb.readthedocs.io/en/stable/user_guide.html).

### 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](https://simdb.readthedocs.io/en/stable/iter_remotes.html).

### 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](https://simdb.readthedocs.io/en/stable/iter_certificate.html).

## Server setup

For information on setting and maintaining a remote CLI server see [here](https://simdb.readthedocs.io/en/stable/maintenance_guide.html).

## Developer guide

Information about setting up a developer environment can be found [here](https://simdb.readthedocs.io/en/stable/developer_guide.html).
