diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 74e0648..63de6cd 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -19,8 +19,9 @@ sphinx: # Optionally, but recommended, # declare the Python requirements required to build your documentation # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -# python: -# install: -# - requirements: docs/requirements.txt +python: + install: + - method: pip + path: .[docs] diff --git a/README.md b/README.md index 0b69746..89cddd4 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,5 @@ # SIKE -```{note} -SIKE is a work in progress and documentation will be coming soon. Please contact power8@llnl.gov for any questions running the code in the meantime. -``` - SIKE (**S**crape-off layer **I**mpurities with **K**inetic **E**lectrons) is a simple atomic kinetics solver for impurity species relevant to magnetic fusion plasmas. It is intended to study the effect of non-Maxwellian electron distributions on mean ionisation, radiative loss rates, etc. For a set of atomic state densities $\vec{n}$, it solves the equation $\frac{d\vec{n}}{dt} = \mathbf{M}\vec{n}$, @@ -14,6 +10,10 @@ The SIKE model and atomic data is described in more detail in Power et al. 2025 SIKE was developed to study the sensitivity of atomic rates to non-Maxwellian electron distributions in magnetic fusion plasmas. It is not currently as accurate as commonly used modelling databases such as ADAS, please see the notebook and comparison plots in the benchmarking directory to get an idea of the differences. +## Documentation + +https://sike.readthedocs.io/en/latest/ + ## Quickstart ```{note} diff --git a/docs/Makefile b/docs/Makefile index 401d9a3..269cadc 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -6,7 +6,7 @@ SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build SOURCEDIR = source -BUILDDIR = _build +BUILDDIR = build # Put it first so that "make" without argument is like "make help". help: diff --git a/docs/source/conf.py b/docs/source/conf.py index 350ea14..e28f502 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -34,7 +34,7 @@ autosummary_generate = True templates_path = ["_templates"] -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] +exclude_patterns = ["build", "Thumbs.db", ".DS_Store"] autodoc_default_options = {"ignore-module-all": True} autodoc_typehints = "description" @@ -93,4 +93,4 @@ "python": ("https://docs.python.org/3", None), "numpy": ("https://numpy.org/doc/stable", None), "scipy": ("https://docs.scipy.org/doc/scipy", None), -} \ No newline at end of file +}