sirocco 0.0.0.dev0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,163 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py,cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ #Pipfile.lock
96
+
97
+ # poetry
98
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102
+ #poetry.lock
103
+
104
+ # pdm
105
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106
+ #pdm.lock
107
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108
+ # in version control.
109
+ # https://pdm.fming.dev/latest/usage/project/#working-with-version-control
110
+ .pdm.toml
111
+ .pdm-python
112
+ .pdm-build/
113
+
114
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
115
+ __pypackages__/
116
+
117
+ # Celery stuff
118
+ celerybeat-schedule
119
+ celerybeat.pid
120
+
121
+ # SageMath parsed files
122
+ *.sage.py
123
+
124
+ # Environments
125
+ .env
126
+ .venv
127
+ env/
128
+ venv/
129
+ ENV/
130
+ env.bak/
131
+ venv.bak/
132
+
133
+ # Spyder project settings
134
+ .spyderproject
135
+ .spyproject
136
+
137
+ # Rope project settings
138
+ .ropeproject
139
+
140
+ # mkdocs documentation
141
+ /site
142
+
143
+ # mypy
144
+ .mypy_cache/
145
+ .dmypy.json
146
+ dmypy.json
147
+
148
+ # Pyre type checker
149
+ .pyre/
150
+
151
+ # pytype static type analyzer
152
+ .pytype/
153
+
154
+ # Cython debug symbols
155
+ cython_debug/
156
+
157
+ # PyCharm
158
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
159
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
160
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
161
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
162
+ #.idea/
163
+
@@ -0,0 +1,52 @@
1
+ Metadata-Version: 2.3
2
+ Name: sirocco
3
+ Version: 0.0.0.dev0
4
+ Summary: A library for creating weather and climate workflows.
5
+ Project-URL: Repository, https://github.com/C2SM/Sirocco.git
6
+ Project-URL: Changelog, https://github.com/C2SM/Sirocco/blob/main/CHANGELOG.md
7
+ Author-email: Matthieu Leclair <matthieu.leclair@env.ethz.ch>, Julian Geiger <julian.geiger@psi.ch>, Alexander Goscinski <alexander.goscinski@psi.ch>
8
+ Keywords: icon,aiida,aiida-workgraph,workflow
9
+ Classifier: Development Status :: 1 - Planning
10
+ Classifier: Intended Audience :: Science/Research
11
+ Classifier: Operating System :: POSIX :: Linux
12
+ Classifier: Programming Language :: Python
13
+ Classifier: Programming Language :: Python :: 3.12
14
+ Classifier: Topic :: Scientific/Engineering
15
+ Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
16
+ Requires-Python: >=3.12
17
+ Requires-Dist: aiida-core>=2.5
18
+ Requires-Dist: isoduration
19
+ Requires-Dist: pydantic
20
+ Requires-Dist: pydantic-yaml
21
+ Description-Content-Type: text/markdown
22
+
23
+ # Sirocco
24
+
25
+ Sirocco is a library for creating weather and climate workflows from a yaml
26
+ format inspired by [cylc](https://cylc.github.io/) using
27
+ [AiiDA](https://www.aiida.net/) as workflow engine.
28
+
29
+ ## Install
30
+
31
+ To install it please use
32
+
33
+ ``` bash
34
+ pip install -e .
35
+ ```
36
+
37
+ ## Developer tools
38
+
39
+ To manage the repo we use [hatch]{.title-ref} please install it
40
+
41
+ ``` bash
42
+ pip install hatch
43
+ hatch test # run tests
44
+ hatch fmt # run formatting
45
+ hatch run docs:build # build docs
46
+ hatch run docs:serve # live preview of doc for development
47
+ ```
48
+
49
+ ## Resources
50
+
51
+ - <https://aiida-workgraph.readthedocs.io/en/latest/>
52
+ - <https://github.com/aiidateam/aiida-workgraph>
@@ -0,0 +1,30 @@
1
+ # Sirocco
2
+
3
+ Sirocco is a library for creating weather and climate workflows from a yaml
4
+ format inspired by [cylc](https://cylc.github.io/) using
5
+ [AiiDA](https://www.aiida.net/) as workflow engine.
6
+
7
+ ## Install
8
+
9
+ To install it please use
10
+
11
+ ``` bash
12
+ pip install -e .
13
+ ```
14
+
15
+ ## Developer tools
16
+
17
+ To manage the repo we use [hatch]{.title-ref} please install it
18
+
19
+ ``` bash
20
+ pip install hatch
21
+ hatch test # run tests
22
+ hatch fmt # run formatting
23
+ hatch run docs:build # build docs
24
+ hatch run docs:serve # live preview of doc for development
25
+ ```
26
+
27
+ ## Resources
28
+
29
+ - <https://aiida-workgraph.readthedocs.io/en/latest/>
30
+ - <https://github.com/aiidateam/aiida-workgraph>
@@ -0,0 +1,87 @@
1
+ [build-system]
2
+ requires = ["hatchling"]
3
+ build-backend = "hatchling.build"
4
+
5
+ [project]
6
+ # See https://www.python.org/dev/peps/pep-0621/
7
+ name = 'sirocco'
8
+ dynamic = ["version"]
9
+ description = 'A library for creating weather and climate workflows.'
10
+ authors = [
11
+ {name = 'Matthieu Leclair', email = 'matthieu.leclair@env.ethz.ch'},
12
+ {name = 'Julian Geiger', email = 'julian.geiger@psi.ch'},
13
+ {name = 'Alexander Goscinski', email = 'alexander.goscinski@psi.ch'},
14
+ ]
15
+ readme = 'README.md'
16
+ classifiers = [
17
+ 'Development Status :: 1 - Planning',
18
+ 'Intended Audience :: Science/Research',
19
+ 'Operating System :: POSIX :: Linux',
20
+ 'Programming Language :: Python',
21
+ 'Programming Language :: Python :: 3.12',
22
+ 'Topic :: Scientific/Engineering',
23
+ 'Topic :: Scientific/Engineering :: Atmospheric Science',
24
+ ]
25
+ keywords = ["workflow"," icon", "aiida", "aiida-workgraph"]
26
+ requires-python = '>=3.12'
27
+ dependencies = [
28
+ "isoduration",
29
+ "pydantic",
30
+ "pydantic-yaml",
31
+ "aiida-core>=2.5"
32
+ ]
33
+ [project.urls]
34
+ Repository = "https://github.com/C2SM/Sirocco.git"
35
+ Changelog = "https://github.com/C2SM/Sirocco/blob/main/CHANGELOG.md"
36
+
37
+ [tool.pytest.ini_options]
38
+ # Configuration for [pytest](https://docs.pytest.org)
39
+ addopts = "--pdbcls=IPython.terminal.debugger:TerminalPdb"
40
+
41
+ [tool.coverage.run]
42
+ # Configuration of [coverage.py](https://coverage.readthedocs.io)
43
+ # reporting which lines of your plugin are covered by tests
44
+ source = ["sirocco"]
45
+
46
+ [tool.ruff]
47
+ include = ["src/*py", "tests/*py"]
48
+ target-version = "py39"
49
+
50
+ [tool.ruff.lint]
51
+ ignore = [
52
+ "TID252", # prefer relative import over absolute
53
+ "TRY003", # write custom error messages for formatting
54
+ ]
55
+
56
+ ## Hatch configurations
57
+
58
+ [tool.hatch.build.targets.sdist]
59
+ include = [
60
+ "src/sirocco/",
61
+ ]
62
+
63
+ [tool.hatch.version]
64
+ path = "src/sirocco/__init__.py"
65
+
66
+ [tool.hatch.envs.hatch-test]
67
+ extra-dependencies = [
68
+ "ipdb"
69
+ ]
70
+
71
+ [[tool.hatch.envs.hatch-test.matrix]]
72
+ python = ["3.12"]
73
+
74
+ [tool.hatch.envs.docs]
75
+ description = "Build the documentation"
76
+ extra-dependencies = [
77
+ "mkdocs-material",
78
+ ]
79
+
80
+ [tool.hatch.envs.docs.scripts]
81
+ build = [
82
+ "mkdocs build -f docs/mkdocs.yml",
83
+ "echo 'Now open docs/build/index.html with your browser'"
84
+ ]
85
+ serve = [
86
+ "mkdocs serve -f docs/mkdocs.yml",
87
+ ]
@@ -0,0 +1,5 @@
1
+ from . import parsing
2
+
3
+ __all__ = ["parsing"]
4
+
5
+ __version__ = "0.0.0-dev0"