diff --git a/README.rst b/README.rst index ba00a22..f6fe87c 100644 --- a/README.rst +++ b/README.rst @@ -1,32 +1,36 @@ -# [AiiDA](https://www.aiida.net/) based Weather and Climate Workflow Tool -WcFlow a library for creating weather and climate workflows from a ~yaml~ format inspired by [cylc](https://cylc.github.io/). +Weather and Climate Workflow Tool based on AiiDA +================================================ -## Install +.. marker-readme + +WcFlow a library for creating weather and climate workflows from a yaml format inspired by `cylc `_ using `AiiDA `_ as workflow engine. + +.. marker-installation + +Install +------- To install it please use -``` -pip install -e . -``` +.. code-block:: bash + + pip install -e . -## Developer tools +.. marker-developer-tools + +Developer tools +--------------- To manage the repo we use `hatch` please install it -``` -pip install hatch -hatch test # run tests -hatch fmt # run formatting -hatch run docs:build # build docs -``` - - -## Config Format - -## Parser -## Previewer -## ICON plugin -## AiiDA Shell -## AiiDA WorkGraph -## Resources: + +.. code-block:: bash + + pip install hatch + hatch test # run tests + hatch fmt # run formatting + hatch run docs:build # build docs + +Resources +--------- - https://aiida-workgraph.readthedocs.io/en/latest/ - https://github.com/superstar54/aiida-workgraph diff --git a/docs/src/getting_started.rst b/docs/src/getting_started.rst index a13831d..70fbe2b 100644 --- a/docs/src/getting_started.rst +++ b/docs/src/getting_started.rst @@ -1,2 +1,6 @@ Getting started =============== + +.. include:: ../../README.rst + :start-after: marker-readme + :end-before: marker-developer-tools diff --git a/docs/src/index.rst b/docs/src/index.rst index f3d6c8c..2e9ee9c 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -1,3 +1,3 @@ .. toctree:: - workflow.md + getting_started.rst diff --git a/pyproject.toml b/pyproject.toml index 2d21f8e..a87d8ba 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,7 +12,7 @@ authors = [ {name = 'Julian Geiger', email = 'julian.geiger@psi.ch'}, {name = 'Alexander Goscinski', email = 'alexander.goscinski@psi.ch'}, ] -readme = 'README.md' +readme = 'README.rst' classifiers = [ 'Development Status :: 1 - Planning', 'Intended Audience :: Science/Research', @@ -25,7 +25,7 @@ classifiers = [ 'Topic :: Scientific/Engineering', 'Topic :: Scientific/Engineering :: Atmospheric Science', ] -keywords = ["wc", "workflow"," icon", "aiida", "workgraph"] +keywords = ["wc", "workflow"," icon", "aiida", "aiida-workgraph"] requires-python = '>=3.9' dependencies = [ ]