solarnet-metadata 3.2.0__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.
Files changed (76) hide show
  1. solarnet_metadata-3.2.0/.github/ISSUE_TEMPLATE/bug_report.md +55 -0
  2. solarnet_metadata-3.2.0/.github/ISSUE_TEMPLATE/feature_request.md +38 -0
  3. solarnet_metadata-3.2.0/.github/ISSUE_TEMPLATE/keyword_issue.md +21 -0
  4. solarnet_metadata-3.2.0/.github/ISSUE_TEMPLATE/text-improvement.md +21 -0
  5. solarnet_metadata-3.2.0/.github/workflows/codestyle.yml +39 -0
  6. solarnet_metadata-3.2.0/.github/workflows/docs.yml +36 -0
  7. solarnet_metadata-3.2.0/.github/workflows/release.yml +72 -0
  8. solarnet_metadata-3.2.0/.github/workflows/test-release.yml +75 -0
  9. solarnet_metadata-3.2.0/.github/workflows/testing.yml +43 -0
  10. solarnet_metadata-3.2.0/.gitignore +144 -0
  11. solarnet_metadata-3.2.0/.pre-commit-config.yaml +53 -0
  12. solarnet_metadata-3.2.0/.readthedocs.yaml +38 -0
  13. solarnet_metadata-3.2.0/.zenodo.json +58 -0
  14. solarnet_metadata-3.2.0/CHANGELOG.rst +41 -0
  15. solarnet_metadata-3.2.0/CODE_OF_CONDUCT.md +131 -0
  16. solarnet_metadata-3.2.0/LICENSE.txt +317 -0
  17. solarnet_metadata-3.2.0/PKG-INFO +36 -0
  18. solarnet_metadata-3.2.0/README.md +28 -0
  19. solarnet_metadata-3.2.0/docs/Makefile +20 -0
  20. solarnet_metadata-3.2.0/docs/_static/class_new_highlight.css +5 -0
  21. solarnet_metadata-3.2.0/docs/_static/custom.css +38 -0
  22. solarnet_metadata-3.2.0/docs/_static/fits_coordinate_calculation_flowchart.png +0 -0
  23. solarnet_metadata-3.2.0/docs/_static/wide_navbar.css +14 -0
  24. solarnet_metadata-3.2.0/docs/api.rst +12 -0
  25. solarnet_metadata-3.2.0/docs/appendix.rst +15 -0
  26. solarnet_metadata-3.2.0/docs/citation.rst +51 -0
  27. solarnet_metadata-3.2.0/docs/conf.py +177 -0
  28. solarnet_metadata-3.2.0/docs/dev-guide/code_standards.rst +162 -0
  29. solarnet_metadata-3.2.0/docs/dev-guide/docs.rst +88 -0
  30. solarnet_metadata-3.2.0/docs/dev-guide/index.rst +17 -0
  31. solarnet_metadata-3.2.0/docs/dev-guide/maintainer_workflow.rst +166 -0
  32. solarnet_metadata-3.2.0/docs/dev-guide/tests.rst +61 -0
  33. solarnet_metadata-3.2.0/docs/dev-guide/version_guidelines.rst +106 -0
  34. solarnet_metadata-3.2.0/docs/index.rst +108 -0
  35. solarnet_metadata-3.2.0/docs/keyword_processor.py +198 -0
  36. solarnet_metadata-3.2.0/docs/logo/favicon.ico +0 -0
  37. solarnet_metadata-3.2.0/docs/logo/logo.png +0 -0
  38. solarnet_metadata-3.2.0/docs/make.bat +35 -0
  39. solarnet_metadata-3.2.0/docs/references.md +38 -0
  40. solarnet_metadata-3.2.0/docs/solarnet-emails.txt +119 -0
  41. solarnet_metadata-3.2.0/docs/source/appendix-1.md +150 -0
  42. solarnet_metadata-3.2.0/docs/source/appendix-2.md +164 -0
  43. solarnet_metadata-3.2.0/docs/source/appendix-3.md +45 -0
  44. solarnet_metadata-3.2.0/docs/source/appendix-4.md +24 -0
  45. solarnet_metadata-3.2.0/docs/source/appendix-5.md +106 -0
  46. solarnet_metadata-3.2.0/docs/source/appendix-6.md +67 -0
  47. solarnet_metadata-3.2.0/docs/source/appendix-7.md +35 -0
  48. solarnet_metadata-3.2.0/docs/source/appendix-8.md +9 -0
  49. solarnet_metadata-3.2.0/docs/source/appendix-9.md +171 -0
  50. solarnet_metadata-3.2.0/docs/source/parta.md +636 -0
  51. solarnet_metadata-3.2.0/docs/source/partb.md +475 -0
  52. solarnet_metadata-3.2.0/docs/source/partc.md +27 -0
  53. solarnet_metadata-3.2.0/docs/user-guide/acknowledging.rst +29 -0
  54. solarnet_metadata-3.2.0/docs/user-guide/index.rst +17 -0
  55. solarnet_metadata-3.2.0/docs/user-guide/install_guide.rst +36 -0
  56. solarnet_metadata-3.2.0/docs/user-guide/solarnet_schema_customization.rst +207 -0
  57. solarnet_metadata-3.2.0/docs/user-guide/templates.rst +115 -0
  58. solarnet_metadata-3.2.0/docs/user-guide/validation.rst +186 -0
  59. solarnet_metadata-3.2.0/docs/whatsnew/index.rst +7 -0
  60. solarnet_metadata-3.2.0/pyproject.toml +112 -0
  61. solarnet_metadata-3.2.0/setup.cfg +8 -0
  62. solarnet_metadata-3.2.0/solarnet_metadata/__init__.py +13 -0
  63. solarnet_metadata-3.2.0/solarnet_metadata/_version.py +34 -0
  64. solarnet_metadata-3.2.0/solarnet_metadata/data/README.rst +6 -0
  65. solarnet_metadata-3.2.0/solarnet_metadata/data/SOLARNET_attr_schema.yaml +1791 -0
  66. solarnet_metadata-3.2.0/solarnet_metadata/schema.py +419 -0
  67. solarnet_metadata-3.2.0/solarnet_metadata/tests/__init__.py +4 -0
  68. solarnet_metadata-3.2.0/solarnet_metadata/tests/test_schema.py +575 -0
  69. solarnet_metadata-3.2.0/solarnet_metadata/tests/test_validation.py +597 -0
  70. solarnet_metadata-3.2.0/solarnet_metadata/util.py +52 -0
  71. solarnet_metadata-3.2.0/solarnet_metadata/validation.py +457 -0
  72. solarnet_metadata-3.2.0/solarnet_metadata.egg-info/PKG-INFO +36 -0
  73. solarnet_metadata-3.2.0/solarnet_metadata.egg-info/SOURCES.txt +75 -0
  74. solarnet_metadata-3.2.0/solarnet_metadata.egg-info/dependency_links.txt +1 -0
  75. solarnet_metadata-3.2.0/solarnet_metadata.egg-info/requires.txt +22 -0
  76. solarnet_metadata-3.2.0/solarnet_metadata.egg-info/top_level.txt +1 -0
@@ -0,0 +1,55 @@
1
+ ---
2
+ name: Bug Report
3
+ about: Create a report describing unexpected or incorrect behavior in the `solarnet_metadata` package.
4
+ title: "[TEXT]"
5
+ labels: bug
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ We know opening issues takes effort, and we appreciate your time.
11
+
12
+ Please be aware that everyone has to follow our [code of conduct](https://github.com/IHDE-Alliance/solarnet_metadata?tab=coc-ov-file)
13
+
14
+ Please have a search on our GitHub repository to see if a similar issue has already been posted.
15
+ If a similar issue is closed, have a quick look to see if you are satisfied by the resolution.
16
+ If not please go ahead and open a new issue!
17
+
18
+ **Describe the bug you're experiencing**
19
+
20
+ A clear and concise description of what the bug is.
21
+
22
+ ```
23
+ Please include the relevant log output.
24
+ ```
25
+
26
+ **How to Reproduce**
27
+
28
+ Please include code that reproduces the issue whenever possible. The best reproductions are self-contained scripts with minimal dependencies.
29
+
30
+ ```
31
+ Sample code to reproduce the problem
32
+ ```
33
+
34
+ **Screenshots**
35
+
36
+ ```
37
+ If applicable, add screenshots to help explain your problem.
38
+ ```
39
+
40
+ **System Details**
41
+
42
+ You can run the following and paste the result in a code block.
43
+ This will help us identify your environment.
44
+
45
+ ```
46
+ import platform
47
+ import sys
48
+ import astropy
49
+ import solarnet_metadata
50
+
51
+ print(platform.platform())
52
+ print(sys.version_info)
53
+ print('astropy={0}'.format(astropy.__version__))
54
+ print('solarnet_metadata={0}'.format(solarnet_metadata.__version__))
55
+ ```
@@ -0,0 +1,38 @@
1
+ ---
2
+ name: Feature Request
3
+ about: Suggest an idea for a new feature or improvement in the `solarnet_metadata` package.
4
+ title: "[TEXT]"
5
+ labels: enhancement
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ We know opening issues takes effort, and we appreciate your time.
11
+
12
+ Please be aware that everyone has to follow our [code of conduct](https://github.com/IHDE-Alliance/solarnet_metadata?tab=coc-ov-file)
13
+
14
+ Please have a search on our GitHub repository to see if a similar issue has already been posted.
15
+ If a similar issue is closed, have a quick look to see if you are satisfied by the resolution.
16
+ If not please go ahead and open a new issue!
17
+
18
+ **What is the problem this feature will solve?**
19
+
20
+ What are you trying to do, that you are unable to achieve with the `solarnet_metadata` package and its affiliated packages as it currently stands?
21
+
22
+ ```
23
+ * I'm always frustrated when [...] because [...]
24
+ * I would like it if [...] happened when I [...] because [...]
25
+ * Here is a sample image of what I am asking for [...]
26
+ ```
27
+
28
+ **Describe the desired outcome**
29
+
30
+ Clear and concise description of what you want to happen. Please use examples of real world use cases that this would help with, and how it solves the problem described above.
31
+
32
+ **Proposed solution**
33
+
34
+ Describe a way to accomplish the goals of this feature request. If you want to, you can suggest a draft design or API so we can have a deeper discussion on the feature.
35
+
36
+ **Additional Context**
37
+
38
+ Add any other context, links, etc. relevant to the feature request. You may also include screenshots if necessary.
@@ -0,0 +1,21 @@
1
+ ---
2
+ name: Keyword Suggestion
3
+ about: A suggestion to modify an existing keyword definition or add a new keyword.
4
+ title: "Keyword: [TEXT]"
5
+ labels: keyword
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **Keyword name and description**
11
+ Provide the name of the existing keyword and its description or if a new keyword, suggest a new keyword name and description.
12
+ Provide it in this format on a single line, keyword: description.
13
+ Make sure to capitalize the keyword.
14
+
15
+ **Describe your suggestion**
16
+ A clear and concise description of what your suggestion is. If this is to modify an existing keyword usage, explain why the current usage is not adequare or appropriate.
17
+ If this is for a new keyword, explain why this new keyword is needed.
18
+
19
+ **Additional context**
20
+ Add any other context about the problem here.
21
+ For example, you might point to the section of the documentation where this keyword would be described.
@@ -0,0 +1,21 @@
1
+ ---
2
+ name: Text Improvement
3
+ about: A suggestion to improve the text clarity, organization, or to flag a simple
4
+ typo
5
+ title: "[TEXT]"
6
+ labels: text
7
+ assignees: ''
8
+
9
+ ---
10
+
11
+ **Describe your suggestion**
12
+ A clear and concise description of what your suggestion is. This might be to flag a typo, issue with grammar, or how to improve clarity or organization of the text.
13
+
14
+ **Location**
15
+ Provide the section heading and location of the text in question to the best of your ability.
16
+
17
+ **Describe your suggestion**
18
+ Provide a suggested fix if you have one.
19
+
20
+ **Additional context**
21
+ Add any other context about the problem here.
@@ -0,0 +1,39 @@
1
+ # This workflow will install Python dependencies, run tests, run linting, and test building docs
2
+ name: Codestyle and Linting
3
+
4
+ on:
5
+ push:
6
+ branches:
7
+ - main
8
+ pull_request:
9
+ branches: # run for all branches
10
+ workflow_dispatch: # For on demand runs
11
+ schedule:
12
+ - cron: 0 0 * * * # Scheduled run every day at midnight
13
+ jobs:
14
+ build:
15
+
16
+ runs-on: ${{ matrix.platform }}
17
+ strategy:
18
+ fail-fast: false
19
+ matrix:
20
+ platform: [ubuntu-latest]
21
+ python-version: ['3.13']
22
+
23
+ steps:
24
+ - uses: actions/checkout@v2
25
+ - name: Set up Python ${{ matrix.python-version }}
26
+ uses: actions/setup-python@v2
27
+ with:
28
+ python-version: ${{ matrix.python-version }}
29
+ - name: Install dependencies
30
+ run: |
31
+ pip install pip setuptools wheel --upgrade
32
+ python -m pip install -e '.[style]'
33
+ - name: Lint with Black
34
+ run: |
35
+ black --check --diff solarnet_metadata
36
+ - name: flake8
37
+ run: |
38
+ flake8 --count solarnet_metadata
39
+
@@ -0,0 +1,36 @@
1
+ # This workflow will install Python dependencies, run tests, run linting, and build docs
2
+ name: Building Docs
3
+
4
+ on:
5
+ push:
6
+ branches:
7
+ - main
8
+ pull_request:
9
+ branches: # run for all branches
10
+ workflow_dispatch: # For on demand runs
11
+ schedule:
12
+ - cron: 0 0 * * * # Scheduled run every day at midnight
13
+ jobs:
14
+ build:
15
+
16
+ runs-on: ${{ matrix.platform }}
17
+ strategy:
18
+ fail-fast: false
19
+ matrix:
20
+ platform: [ubuntu-latest]
21
+ python-version: ['3.13']
22
+
23
+ steps:
24
+ - uses: actions/checkout@v2
25
+ - name: Set up Python ${{ matrix.python-version }}
26
+ uses: actions/setup-python@v2
27
+ with:
28
+ python-version: ${{ matrix.python-version }}
29
+ - name: rstcheck
30
+ run: |
31
+ pip install -e .[style,docs,all]
32
+ rstcheck -r docs
33
+ - name: Install Graphviz
34
+ run: sudo apt-get update && sudo apt-get install -y graphviz
35
+ - name: Build docs
36
+ run: sphinx-build docs docs/_build/html -W -b html
@@ -0,0 +1,72 @@
1
+ name: Build and upload to PyPI
2
+
3
+ concurrency:
4
+ group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}
5
+ cancel-in-progress: true
6
+
7
+ on:
8
+ release:
9
+ types:
10
+ - published
11
+
12
+ jobs:
13
+
14
+ build_sdist:
15
+ name: Build source distribution
16
+ runs-on: ubuntu-latest
17
+ outputs:
18
+ SDIST_NAME: ${{ steps.sdist.outputs.SDIST_NAME }}
19
+
20
+ steps:
21
+ - uses: actions/checkout@v4
22
+ with:
23
+ # We need the full history to generate the proper version number
24
+ fetch-depth: 0
25
+
26
+ - uses: actions/setup-python@v4
27
+ name: Install Python
28
+ with:
29
+ python-version: '3.11'
30
+
31
+ - name: Install dependencies
32
+ run: python -m pip install build twine
33
+
34
+ - name: Build sdist
35
+ id: sdist
36
+ run: |
37
+ python -m build --sdist
38
+ # Get the name of the build sdist file for later use
39
+ echo "SDIST_NAME=$(ls -1 dist)" >> $GITHUB_OUTPUT
40
+
41
+ - name: Check README rendering for PyPI
42
+ run: twine check dist/*
43
+
44
+ - name: Upload sdist result
45
+ uses: actions/upload-artifact@v4
46
+ with:
47
+ name: sdist
48
+ path: dist/*.tar.gz
49
+ if-no-files-found: error
50
+
51
+ pypi-publish:
52
+ name: Upload release to PyPI
53
+ runs-on: ubuntu-latest
54
+ needs: build_sdist
55
+ environment:
56
+ name: pypi
57
+ url: https://pypi.org/p/solarnet_metadata
58
+ permissions:
59
+ id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
60
+
61
+ steps:
62
+ - name: Download sdist
63
+ uses: actions/download-artifact@v4
64
+ with:
65
+ name: sdist
66
+ path: dist
67
+
68
+ - name: Publish package distributions to PyPI
69
+ uses: pypa/gh-action-pypi-publish@release/v1
70
+ with:
71
+ verbose: true
72
+ password: ${{ secrets.PYPI_API_TOKEN }}
@@ -0,0 +1,75 @@
1
+ name: Build and upload to TestPyPI
2
+
3
+ concurrency:
4
+ group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}
5
+ cancel-in-progress: true
6
+
7
+ on:
8
+ workflow_dispatch: # For on demand runs
9
+ release:
10
+ types:
11
+ - published
12
+
13
+ jobs:
14
+
15
+ build_sdist:
16
+ name: Build source distribution
17
+ runs-on: ubuntu-latest
18
+ outputs:
19
+ SDIST_NAME: ${{ steps.sdist.outputs.SDIST_NAME }}
20
+
21
+ steps:
22
+ - uses: actions/checkout@v4
23
+ with:
24
+ # We need the full history to generate the proper version number
25
+ fetch-depth: 0
26
+
27
+ - uses: actions/setup-python@v4
28
+ name: Install Python
29
+ with:
30
+ python-version: '3.13'
31
+
32
+ - name: Install dependencies
33
+ run: python -m pip install build twine
34
+
35
+ - name: Build sdist
36
+ id: sdist
37
+ run: |
38
+ python -m build --sdist
39
+ # Get the name of the build sdist file for later use
40
+ echo "SDIST_NAME=$(ls -1 dist)" >> $GITHUB_OUTPUT
41
+
42
+ - name: Check README rendering for PyPI
43
+ run: twine check dist/*
44
+
45
+ - name: Upload sdist result
46
+ uses: actions/upload-artifact@v4
47
+ with:
48
+ name: sdist
49
+ path: dist/*.tar.gz
50
+ if-no-files-found: error
51
+
52
+ test-pypi-publish:
53
+ name: Upload release to TestPyPI
54
+ runs-on: ubuntu-latest
55
+ needs: build_sdist
56
+ environment:
57
+ name: testpypi
58
+ url: https://test.pypi.org/p/solarnet_metadata
59
+ permissions:
60
+ id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
61
+
62
+ steps:
63
+ - name: Download sdist
64
+ uses: actions/download-artifact@v4
65
+ with:
66
+ name: sdist
67
+ path: dist
68
+
69
+ - name: Publish package distributions to TestPyPI
70
+ uses: pypa/gh-action-pypi-publish@release/v1
71
+ with:
72
+ verbose: true
73
+ password: ${{ secrets.TEST_PYPI_API_TOKEN }}
74
+ repository-url: https://test.pypi.org/legacy/
75
+
@@ -0,0 +1,43 @@
1
+ # This workflow will install Python dependencies, run tests, run linting, and test building docs
2
+ name: Testing
3
+
4
+ on:
5
+ push:
6
+ branches:
7
+ - main
8
+ pull_request:
9
+ branches: # run for all branches
10
+ workflow_dispatch: # For on demand runs
11
+ schedule:
12
+ - cron: 0 0 * * * # Scheduled run every day at midnight
13
+ jobs:
14
+ build:
15
+
16
+ runs-on: ${{ matrix.platform }}
17
+ strategy:
18
+ fail-fast: false
19
+ matrix:
20
+ platform: [ubuntu-latest, macos-latest, windows-latest]
21
+ python-version: ['3.10', '3.11', '3.12', '3.13']
22
+
23
+ steps:
24
+ - uses: actions/checkout@v2
25
+ - name: Set up Python ${{ matrix.python-version }}
26
+ uses: actions/setup-python@v2
27
+ with:
28
+ python-version: ${{ matrix.python-version }}
29
+
30
+ - name: Install dependencies
31
+ run: |
32
+ pip install pip setuptools wheel --upgrade
33
+ pip install -e .[test]
34
+
35
+ - name: Run Tests
36
+ run: pytest --pyargs solarnet_metadata --cov solarnet_metadata
37
+ env:
38
+ PLATFORM: ${{ matrix.platform }}
39
+
40
+ - name: Upload coverage reports to Codecov
41
+ uses: codecov/codecov-action@v4.0.1
42
+ with:
43
+ token: ${{ secrets.CODECOV_TOKEN }}
@@ -0,0 +1,144 @@
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
+ pip-wheel-metadata/
24
+ share/python-wheels/
25
+ *.egg-info/
26
+ .installed.cfg
27
+ *.egg
28
+ MANIFEST
29
+
30
+ # PyInstaller
31
+ # Usually these files are written by a python script from a template
32
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
33
+ *.manifest
34
+ *.spec
35
+
36
+ # Installer logs
37
+ pip-log.txt
38
+ pip-delete-this-directory.txt
39
+
40
+ # Unit test / coverage reports
41
+ htmlcov/
42
+ .tox/
43
+ .nox/
44
+ .coverage
45
+ .coverage.*
46
+ .cache
47
+ nosetests.xml
48
+ coverage.xml
49
+ *.cover
50
+ *.py,cover
51
+ .hypothesis/
52
+ .pytest_cache/
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
+ target/
76
+
77
+ # Jupyter Notebook
78
+ .ipynb_checkpoints
79
+ *.ipynb
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ .python-version
87
+
88
+ # pylint / pyreverse
89
+ *.dot
90
+ *.png
91
+
92
+ # pipenv
93
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
94
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
95
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
96
+ # install all needed dependencies.
97
+ #Pipfile.lock
98
+
99
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow
100
+ __pypackages__/
101
+
102
+ # Celery stuff
103
+ celerybeat-schedule
104
+ celerybeat.pid
105
+
106
+ # SageMath parsed files
107
+ *.sage.py
108
+
109
+ # Environments
110
+ .env
111
+ .venv
112
+ env/
113
+ venv/
114
+ ENV/
115
+ env.bak/
116
+ venv.bak/
117
+ .vscode/launch.json
118
+
119
+ # Spyder project settings
120
+ .spyderproject
121
+ .spyproject
122
+
123
+ # Rope project settings
124
+ .ropeproject
125
+
126
+ # mkdocs documentation
127
+ /site
128
+
129
+ # mypy
130
+ .mypy_cache/
131
+ .dmypy.json
132
+ dmypy.json
133
+
134
+ # Pyre type checker
135
+ .pyre/
136
+
137
+ # Mac hidden files
138
+ .DS_Store
139
+
140
+ # files generated by sphinx
141
+ docs/generated
142
+ docs/build
143
+
144
+ _version.py
@@ -0,0 +1,53 @@
1
+ exclude: '.git|.tox'
2
+
3
+ repos:
4
+ # The warnings/errors we check for here are:
5
+ # E101 - mix of tabs and spaces
6
+ # W191 - use of tabs
7
+ # W291 - trailing whitespace
8
+ # W292 - no newline at end of file
9
+ # W293 - trailing whitespace
10
+ # W391 - blank line at end of file
11
+ # E111 - 4 spaces per indentation level
12
+ # E112 - 4 spaces per indentation level
13
+ # E113 - 4 spaces per indentation level
14
+ # E303 - too many blank lines (3)
15
+ # E304 - blank lines found after function decorator
16
+ # E305 - expected 2 blank lines after class or function definition
17
+ # E306 - expected 1 blank line before a nested definition
18
+ # E502 - the backslash is redundant between brackets
19
+ # E722 - do not use bare except
20
+ # E901 - SyntaxError or IndentationError
21
+ # E902 - IOError
22
+ # F822: undefined name in __all__
23
+ # F823: local variable name referenced before assignment
24
+ - repo: https://github.com/pycqa/flake8
25
+ rev: 7.0.0
26
+ hooks:
27
+ - id: flake8
28
+ args: ['--count', '--select', 'E101,E11,E111,E112,E113,E121,E122,E123,E124,E125,E126,E127,E128,E129,E131,E133,E20,E211,E231,E241,E242,E251,E252,E26,E265,E266,E27,E301,E302,E303,E304,E305,E306,E401,E402,E502,E701,E711,E712,E713,E714,E722,E731,E901,E902,F822,F823,W191,W291,W292,W293,W391,W601,W602,W603,W604,W605,W690']
29
+
30
+ - repo: https://github.com/psf/black
31
+ rev: 24.1.1
32
+ hooks:
33
+ - id: black
34
+
35
+ - repo: https://github.com/rstcheck/rstcheck
36
+ rev: v6.2.0
37
+ hooks:
38
+ - id: rstcheck
39
+
40
+ - repo: https://github.com/pre-commit/pre-commit-hooks
41
+ rev: v2.4.0
42
+ hooks:
43
+ - id: check-ast
44
+ - id: check-case-conflict
45
+ - id: trailing-whitespace
46
+ exclude: ".*(.fits|.fts|.fit|.txt)$"
47
+ - id: check-yaml
48
+ - id: debug-statements
49
+ - id: check-added-large-files
50
+ # - id: end-of-file-fixer uncommenting this will break the testing of the cookiecutter template
51
+ # exclude: ".*(.fits|.fts|.fit|.txt|tca.*)$"
52
+ - id: mixed-line-ending
53
+ exclude: ".*(.fits|.fts|.fit|.txt|tca.*)$"
@@ -0,0 +1,38 @@
1
+ # .readthedocs.yaml
2
+ # Read the Docs configuration file
3
+ # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4
+
5
+ # Required
6
+ version: 2
7
+
8
+ # Set the OS, Python version and other tools you might need
9
+ build:
10
+ os: ubuntu-22.04
11
+ tools:
12
+ python: "3.12"
13
+ # You can also specify other tool versions:
14
+ # nodejs: "19"
15
+ # rust: "1.64"
16
+ # golang: "1.19"
17
+ apt_packages:
18
+ - graphviz # Add this line to install graphviz
19
+
20
+ # Build documentation in the "docs/" directory with Sphinx
21
+ sphinx:
22
+ configuration: docs/conf.py
23
+
24
+ # Optionally build your docs in additional formats such as PDF and ePub
25
+ formats:
26
+ - pdf
27
+ - epub
28
+
29
+ # Optional but recommended, declare the Python requirements required
30
+ # to build your documentation
31
+ # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
32
+ python:
33
+ install:
34
+ - method: pip
35
+ path: .
36
+ extra_requirements:
37
+ - docs
38
+ - all
@@ -0,0 +1,58 @@
1
+ {
2
+ "title": "SOLARNET Metadata Recommendations for Solar Observations",
3
+ "description": "This document describes the metadata recommendations developed under the SOLARNET EU project, which aims to foster more collaboration and data sharing between both ground-based and space-based Solar observatories.",
4
+ "creators": [
5
+ {
6
+ "name": "Haugan, Stein Vidar Hagfors",
7
+ "affiliation": "Institute of Theoretical Astrophysics, University of Oslo",
8
+ "orcid": "0000-0001-9648-7260"
9
+ },
10
+ {
11
+ "name": "Fredvik, Terje",
12
+ "affiliation": "Institute of Theoretical Astrophysics, University of Oslo",
13
+ "orcid": "0000-0002-8673-3920"
14
+ }
15
+ ],
16
+ "contributors": [
17
+ {
18
+ "name": "Löfdahl, Mats G.",
19
+ "affiliation": "Institute for Solar Physics, Stockholm University",
20
+ "orcid": "0000-0002-2472-5677",
21
+ "type": "ProjectMember"
22
+ },
23
+ {
24
+ "name": "Steven Christe",
25
+ "affiliation": "NASA Goddard Space Flight Center",
26
+ "orcid": "0000-0001-6127-795X",
27
+ "type": "ProjectMember"
28
+ },
29
+ {
30
+ "name": "Andrew Robbertz",
31
+ "affiliation": "NASA Goddard Space Flight Center",
32
+ "orcid": "0009-0008-6857-0882",
33
+ "type": "ProjectMember"
34
+ }
35
+ ],
36
+ "license": "CC-BY-4.0",
37
+ "keywords": [
38
+ "SOLARNET",
39
+ "metadata",
40
+ "solar observations",
41
+ "FITS"
42
+ ],
43
+ "related_identifiers": [
44
+ {
45
+ "relation": "continues",
46
+ "identifier": "https://zenodo.org/records/5719255"
47
+ },
48
+ {
49
+ "relation": "continues",
50
+ "identifier": "https://arxiv.org/abs/2011.12139"
51
+ }
52
+ ],
53
+ "communities": [
54
+ {
55
+ "identifier": "solarnet"
56
+ }
57
+ ]
58
+ }