pyproject.toml

[build-system]
requires = ["setuptools", "packaging>=24.2", "wheel", "setuptools_scm>8"]
build-backend = "setuptools.build_meta"

[project]
name = "imas-idstools"
authors = [{ name = "ITER Organization", email = "imas-support@iter.org" }]
description = "Python based collection of data analysis and visualization tools written in IMAS framework"
readme = { file = "README.md", content-type = "text/markdown" }
requires-python = ">=3.8"
keywords = ["IMAS", "IDS"]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Environment :: Console",
    "Environment :: Plugins",
    "Environment :: X11 Applications",
    "Framework :: Flake8",
    "Framework :: IPython",
    "Framework :: Matplotlib",
    "Framework :: Pytest",
    "Framework :: Sphinx",
    # Custom trove classifiers are not allowed, and newer versions of python setuptools will fail to build
    # when classifiers other than those listed on: https://pypi.org/classifiers/ are included
    #    "Framework :: IMAS",
    "Intended Audience :: Developers",
    "Intended Audience :: Science/Research",
    "Intended Audience :: System Administrators",
    "Natural Language :: English",
    "Operating System :: POSIX",
    "Operating System :: POSIX :: Linux",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Unix Shell",
    "Topic :: Database",
    "Topic :: Database :: Front-Ends",
    "Topic :: Scientific/Engineering",
    "Topic :: Scientific/Engineering :: Physics",
    "Topic :: Scientific/Engineering :: Visualization",
    "Topic :: Software Development :: Libraries",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Topic :: System",
    "Topic :: System :: Software Distribution",
    "Topic :: Utilities",
]
dependencies = [
    "cerberus",
    "fortranformat",
    "imas-python",
    "matplotlib",
    "netCDF4",
    "numpy",
    "packaging",
    "pandas",
    "pyparsing",
    "python-dateutil",
    "pyyaml",
    "rich",
    "rich_argparse",
    "six",
    "tabulate",
]
dynamic = ["version"]


[project.urls]
homepage = "https://github.com/iterorganization/IDStools"

[project.scripts]
# Visualization and analysis tools
plotequilibrium = "idstools.scripts:plotequilibrium"
idslist = "idstools.scripts:idslist"
idsprint = "idstools.scripts:idsprint"
idsperf = "idstools.scripts:idsperf"
plothcd = "idstools.scripts:plothcd"
plotpressure = "idstools.scripts:plotpressure"
plotrotation = "idstools.scripts:plotrotation"
plotequicomp = "idstools.scripts:plotequicomp"
plotcoresources = "idstools.scripts:plotcoresources"
plotkineticprofiles = "idstools.scripts:plotkineticprofiles"
plothcdwaves = "idstools.scripts:plothcdwaves"
plotecray = "idstools.scripts:plotecray"
plothcddistributions = "idstools.scripts:plothcddistributions"
plotedgeprofiles = "idstools.scripts:plotedgeprofiles"
plotmachinedescription = "idstools.scripts:plotmachinedescription"
plotspectrometry = "idstools.scripts:plotspectrometry"
plotneutron = "idstools.scripts:plotneutron"
ploteccomposition = "idstools.scripts:ploteccomposition"
plotecstrayradiation = "idstools.scripts:plotecstrayradiation"
plotscenario = "idstools.scripts:plotscenario"
# Query and data manipulation tools
idsquery = "idstools.scripts:idsquery"
idsresample = "idstools.scripts:idsresample"
idsdiff = "idstools.scripts:idsdiff"
idscp = "idstools.scripts:idscp"
idssize = "idstools.scripts:idssize"
idsrescale_equilibrium = "idstools.scripts:idsrescale_equilibrium"
idsshift_equilibrium = "idstools.scripts:idsshift_equilibrium"
idsrosettacode = "idstools.scripts:idsrosettacode"
eqdsk2ids = "idstools.scripts:eqdsk2ids"
# Database management tools
dbconverter = "idstools.scripts:dbconverter"
dbscraper = "idstools.scripts:dbscraper"
dbselector = "idstools.scripts:dbselector"
dblist = "idstools.scripts:dblist"
dbperf = "idstools.scripts:dbperf"
# Print and report tools
printcoresources = "idstools.scripts:printcoresources"
printplasmacompo = "idstools.scripts:printplasmacompo"
printfluxes = "idstools.scripts:printfluxes"
# Scenario and disruption tools
scenario_status = "idstools.scripts:scenario_status"
scenario_summary = "idstools.scripts:scenario_summary"
disruption_summary = "idstools.scripts:disruption_summary"
# Database entry management
create_db_entry = "idstools.scripts:create_db_entry"
create_db_entry_disruption = "idstools.scripts:create_db_entry_disruption"
show_db_entry = "idstools.scripts:show_db_entry"
watch_db_entry = "idstools.scripts:watch_db_entry"
# Machine description tools
md_status = "idstools.scripts:md_status"
md_summary = "idstools.scripts:md_summary"

[tool.setuptools.packages.find]
where = ["."]
include = ["idstools*"]
exclude = ["*.pyc", "*.pyo"]

[tool.setuptools.package-data]
"idstools.scripts" = ["bin/*"]

[tool.pytest.ini_options]
minversion = "6.0"
addopts = "--strict-markers"
testpaths = "idstools"

[tool.setuptools_scm]
version_file = "idstools/_version.py"
local_scheme = "no-local-version"
version_file_template = """
# file generated by setuptools_scm; DO NOT edit
__all__ = ["__version__", "GIT_REV", "GIT_DESCRIBE", "GIT_DATE"]
__version__ = "{version}"
version_tuple = tuple("{version}".replace("-", ".").split("."))
GIT_REV = "{scm_version.node}"
GIT_DESCRIBE = "{scm_version.tag}-{scm_version.distance}-{scm_version.node}"
GIT_DATE = "{scm_version.node_date}"
"""

[tool.isort]
profile = "black"

[tool.flake8]
max-line-length = 120
ignore = ["E203", "W503"]

[project.optional-dependencies]
# these self-dependencies are available since pip 21.2
all = ["imas-idstools[test,docs]"]
docs = [
    "sphinx>=6.0.0,<7.0.0",
    "astroid<4",
    "numpy",
    "pyparsing",
    "python-dateutil",
    "rst2pdf",
    "sphinx-autoapi",
    "sphinx-autodoc-typehints",
    "sphinx-immaterial>0.11.0,<0.12",
    "sphinx-toolbox",
    "sphinxcontrib-programoutput",
    "click",
    "setuptools-scm",
]

test = ["pytest", "pytest-cov", "pytest-xdist"]


[tool.black]
line-length = 120
exclude = '''
/(
    idstools/_version\.py
)/
'''

[tool.pylint]
max-line-length = 120
disable = ["all"]
enable = ["E"]

[tool.setuptools.data-files]
"bin/validation_schemas/ITER" = ["resources/validation_schemas/ITER/*.*"]
"bin/validation_schemas/generic" = ["resources/validation_schemas/generic/*.*"]
"bin/geqdsk" = ["resources/geqdsk/*.*"]
"bin/input" = ["resources/input/*.*"]
"bin/mappings" = ["resources/mappings/*.*"]
"bin/results" = ["resources/results/*.*"]