solarnet-metadata 3.2.0__tar.gz → 3.2.2__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 (80) hide show
  1. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/.github/workflows/testing.yml +1 -1
  2. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/CHANGELOG.rst +2 -2
  3. solarnet_metadata-3.2.2/PKG-INFO +111 -0
  4. solarnet_metadata-3.2.2/README.rst +74 -0
  5. solarnet_metadata-3.2.2/docs/user-guide/install_guide.rst +30 -0
  6. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/solarnet_metadata/_version.py +3 -3
  7. solarnet_metadata-3.2.2/solarnet_metadata.egg-info/PKG-INFO +111 -0
  8. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/solarnet_metadata.egg-info/SOURCES.txt +1 -1
  9. solarnet_metadata-3.2.0/PKG-INFO +0 -36
  10. solarnet_metadata-3.2.0/README.md +0 -28
  11. solarnet_metadata-3.2.0/docs/user-guide/install_guide.rst +0 -36
  12. solarnet_metadata-3.2.0/solarnet_metadata.egg-info/PKG-INFO +0 -36
  13. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/.github/ISSUE_TEMPLATE/bug_report.md +0 -0
  14. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/.github/ISSUE_TEMPLATE/feature_request.md +0 -0
  15. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/.github/ISSUE_TEMPLATE/keyword_issue.md +0 -0
  16. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/.github/ISSUE_TEMPLATE/text-improvement.md +0 -0
  17. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/.github/workflows/codestyle.yml +0 -0
  18. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/.github/workflows/docs.yml +0 -0
  19. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/.github/workflows/release.yml +0 -0
  20. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/.github/workflows/test-release.yml +0 -0
  21. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/.gitignore +0 -0
  22. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/.pre-commit-config.yaml +0 -0
  23. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/.readthedocs.yaml +0 -0
  24. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/.zenodo.json +0 -0
  25. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/CODE_OF_CONDUCT.md +0 -0
  26. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/LICENSE.txt +0 -0
  27. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/Makefile +0 -0
  28. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/_static/class_new_highlight.css +0 -0
  29. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/_static/custom.css +0 -0
  30. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/_static/fits_coordinate_calculation_flowchart.png +0 -0
  31. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/_static/wide_navbar.css +0 -0
  32. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/api.rst +0 -0
  33. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/appendix.rst +0 -0
  34. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/citation.rst +0 -0
  35. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/conf.py +0 -0
  36. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/dev-guide/code_standards.rst +0 -0
  37. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/dev-guide/docs.rst +0 -0
  38. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/dev-guide/index.rst +0 -0
  39. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/dev-guide/maintainer_workflow.rst +0 -0
  40. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/dev-guide/tests.rst +0 -0
  41. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/dev-guide/version_guidelines.rst +0 -0
  42. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/index.rst +0 -0
  43. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/keyword_processor.py +0 -0
  44. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/logo/favicon.ico +0 -0
  45. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/logo/logo.png +0 -0
  46. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/make.bat +0 -0
  47. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/references.md +0 -0
  48. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/solarnet-emails.txt +0 -0
  49. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/source/appendix-1.md +0 -0
  50. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/source/appendix-2.md +0 -0
  51. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/source/appendix-3.md +0 -0
  52. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/source/appendix-4.md +0 -0
  53. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/source/appendix-5.md +0 -0
  54. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/source/appendix-6.md +0 -0
  55. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/source/appendix-7.md +0 -0
  56. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/source/appendix-8.md +0 -0
  57. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/source/appendix-9.md +0 -0
  58. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/source/parta.md +0 -0
  59. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/source/partb.md +0 -0
  60. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/source/partc.md +0 -0
  61. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/user-guide/acknowledging.rst +0 -0
  62. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/user-guide/index.rst +0 -0
  63. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/user-guide/solarnet_schema_customization.rst +0 -0
  64. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/user-guide/templates.rst +0 -0
  65. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/user-guide/validation.rst +0 -0
  66. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/docs/whatsnew/index.rst +0 -0
  67. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/pyproject.toml +0 -0
  68. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/setup.cfg +0 -0
  69. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/solarnet_metadata/__init__.py +0 -0
  70. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/solarnet_metadata/data/README.rst +0 -0
  71. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/solarnet_metadata/data/SOLARNET_attr_schema.yaml +0 -0
  72. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/solarnet_metadata/schema.py +0 -0
  73. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/solarnet_metadata/tests/__init__.py +0 -0
  74. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/solarnet_metadata/tests/test_schema.py +0 -0
  75. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/solarnet_metadata/tests/test_validation.py +0 -0
  76. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/solarnet_metadata/util.py +0 -0
  77. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/solarnet_metadata/validation.py +0 -0
  78. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/solarnet_metadata.egg-info/dependency_links.txt +0 -0
  79. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/solarnet_metadata.egg-info/requires.txt +0 -0
  80. {solarnet_metadata-3.2.0 → solarnet_metadata-3.2.2}/solarnet_metadata.egg-info/top_level.txt +0 -0
@@ -38,6 +38,6 @@ jobs:
38
38
  PLATFORM: ${{ matrix.platform }}
39
39
 
40
40
  - name: Upload coverage reports to Codecov
41
- uses: codecov/codecov-action@v4.0.1
41
+ uses: codecov/codecov-action@v5
42
42
  with:
43
43
  token: ${{ secrets.CODECOV_TOKEN }}
@@ -1,7 +1,7 @@
1
1
  This project uses `semantic versioning <https://semver.org>`_.
2
2
 
3
- Latest
4
- ======
3
+ 3.2.2
4
+ =====
5
5
 
6
6
  * Added Python package structure with validation and schema functionality:
7
7
  * New ``solarnet_metadata.schema`` module with ``SOLARNETSchema`` class for attribute schema handling
@@ -0,0 +1,111 @@
1
+ Metadata-Version: 2.4
2
+ Name: solarnet_metadata
3
+ Version: 3.2.2
4
+ Summary: A Python package to support metadata attribute management for generating SOLARNET compliant FITS files.
5
+ Author-email: Stein Vidar Hagfors <prits-group@astro.uio.no>, Terje Fredvik <prits-group@astro.uio.no>, Steven Christe <steven.d.christe@nasa.gov>, Andrew Robbertz <a.robbertz@gmail.com>
6
+ Keywords: solarnet_metadata,nasa mission,space weather
7
+ Classifier: Development Status :: 3 - Alpha
8
+ Classifier: Natural Language :: English
9
+ Classifier: Operating System :: OS Independent
10
+ Classifier: Programming Language :: Python
11
+ Classifier: Programming Language :: Python :: 3.10
12
+ Classifier: Intended Audience :: Science/Research
13
+ Classifier: Topic :: Scientific/Engineering
14
+ Classifier: Topic :: Scientific/Engineering :: Physics
15
+ Requires-Python: >=3.10
16
+ Description-Content-Type: text/x-rst
17
+ License-File: LICENSE.txt
18
+ Requires-Dist: pyyaml>=5.3.1
19
+ Requires-Dist: astropy==6.1.*
20
+ Provides-Extra: dev
21
+ Requires-Dist: solarnet_metadata[docs,style,test]; extra == "dev"
22
+ Provides-Extra: docs
23
+ Requires-Dist: myst-parser==3.0.1; extra == "docs"
24
+ Requires-Dist: sphinx==7.2.6; extra == "docs"
25
+ Requires-Dist: sphinx-automodapi==0.16.0; extra == "docs"
26
+ Requires-Dist: sphinx-copybutton==0.5.2; extra == "docs"
27
+ Provides-Extra: test
28
+ Requires-Dist: pytest==8.0.0; extra == "test"
29
+ Requires-Dist: pytest-astropy==0.11.0; extra == "test"
30
+ Requires-Dist: pytest-cov==4.1.0; extra == "test"
31
+ Requires-Dist: coverage[toml]==7.4.1; extra == "test"
32
+ Provides-Extra: style
33
+ Requires-Dist: black==24.1.1; extra == "style"
34
+ Requires-Dist: flake8==7.0.0; extra == "style"
35
+ Requires-Dist: rstcheck==6.2.0; extra == "style"
36
+ Dynamic: license-file
37
+
38
+ SOLARNET Metadata Recommendations for Solar Observations
39
+ ========================================================
40
+
41
+ .. start-badges
42
+
43
+ .. list-table::
44
+ :stub-columns: 1
45
+
46
+ * - docs
47
+ - |docs| |readthedocs|
48
+ * - build status
49
+ - |testing| |codestyle| |coverage|
50
+ * - Project Information
51
+ - |DOI| |CODE_OF_CONDUCT|
52
+
53
+ .. |docs| image:: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/docs.yml/badge.svg
54
+ :target: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/docs.yml
55
+ :alt: Documentation Build Status
56
+
57
+ .. |testing| image:: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/testing.yml/badge.svg
58
+ :target: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/testing.yml
59
+ :alt: Build Status
60
+
61
+ .. |codestyle| image:: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/codestyle.yml/badge.svg
62
+ :target: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/codestyle.yml
63
+ :alt: Codestyle and linting using flake8
64
+
65
+ .. |coverage| image:: https://codecov.io/gh/IHDE-Alliance/solarnet_metadata/graph/badge.svg?token=PZLLKDTPGU
66
+ :target: https://codecov.io/gh/IHDE-Alliance/solarnet_metadata
67
+ :alt: Testing coverage
68
+
69
+ .. |readthedocs| image:: https://readthedocs.org/projects/solarnet-metadata/badge/?version=latest
70
+ :target: https://solarnet-metadata.readthedocs.io/en/latest/?badge=latest
71
+ :alt: ReadTheDocs Status
72
+
73
+ .. |DOI| image:: https://zenodo.org/badge/794299551.svg
74
+ :target: https://doi.org/10.5281/zenodo.15741506
75
+ :alt: DOI
76
+
77
+ .. |CODE_OF_CONDUCT| image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
78
+ :target: CODE_OF_CONDUCT.md
79
+ :alt: Contributor Covenant Code of Conduct
80
+
81
+
82
+ .. end-badges
83
+
84
+ Stein Vidar Hagfors Haugan @steinhh, Terje Fredvik @tfredvik
85
+
86
+ Until the advent of the SOLARNET recommendations, metadata descriptions of Solar observations have been standardized for space-based observations, but the standards have been mostly within a single space mission at a time, at times with significant differences between different mission standards. In the context of ground-based Solar observations, data has typically not been made freely available to the general research community, resulting in an even greater lack of standards for metadata descriptions. This situation makes it difficult to construct multi-instrument archives/virtual observatories with anything more than the most basic metadata available for searching, as well as making it difficult to write generic software for instrument-agnostic data analysis. This document describes the metadata recommendations developed under the SOLARNET EU project, which aims foster more collaboration and data sharing between both ground-based and space-based Solar observatories. The recommendations will be followed by data pipelines developed under the SOLARNET project and others (Solar Orbiter SPICE, SST CHROMIS/CRISP (SSTRED), AISAS/Lomnicky Stit COMP-S/SCD, SAMNET, Gregor HiFI/GFPI, ROB USET, Alma pipeline for Solar data (SOAP), INAF IBIS-A (IBIS data Archive), PADRE/MeDDEA). These recommendations are meant to function as a common reference to which even existing diverse data sets may be related, for ingestion into solar virtual observatories and for analysis by generic software.
87
+
88
+ The original development of this work received funding from the European Union’s Horizon 2020 and FP7 programmes under grant agreements No 824135 and 31295. Version 2.0 of this document was the final version produced under these grants.
89
+
90
+ Documentation
91
+ -------------
92
+
93
+ The latest rendered documentation can be found on `readthedocs <http://solarnet-metadata.rtfd.io/>`_.
94
+
95
+ Acknowledging or Citing The SOLARNET Metadata Recommendations
96
+ -------------------------------------------------------------
97
+
98
+ If you use the SOLARNET Metadata Recommendations in your scientific work, we would appreciate your `citing it in your publications <http://solarnet-metadata.readthedocs.io/en/latest/citation.html>`_.
99
+ The continued growth and development of the SOLARNET Metadata Recommendations is dependent on the community being aware of them.
100
+
101
+ Building the Documentation Locally
102
+ ----------------------------------
103
+
104
+ After cloning the repository, you can build the documentation locally by running the following commands:
105
+
106
+ .. code-block:: bash
107
+
108
+ cd docs
109
+ make clean
110
+ make html # Generates HTML in _build/html
111
+ make latex && cd _build/latex && make && cd ../.. # Generates PDF in _build/latex
@@ -0,0 +1,74 @@
1
+ SOLARNET Metadata Recommendations for Solar Observations
2
+ ========================================================
3
+
4
+ .. start-badges
5
+
6
+ .. list-table::
7
+ :stub-columns: 1
8
+
9
+ * - docs
10
+ - |docs| |readthedocs|
11
+ * - build status
12
+ - |testing| |codestyle| |coverage|
13
+ * - Project Information
14
+ - |DOI| |CODE_OF_CONDUCT|
15
+
16
+ .. |docs| image:: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/docs.yml/badge.svg
17
+ :target: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/docs.yml
18
+ :alt: Documentation Build Status
19
+
20
+ .. |testing| image:: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/testing.yml/badge.svg
21
+ :target: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/testing.yml
22
+ :alt: Build Status
23
+
24
+ .. |codestyle| image:: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/codestyle.yml/badge.svg
25
+ :target: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/codestyle.yml
26
+ :alt: Codestyle and linting using flake8
27
+
28
+ .. |coverage| image:: https://codecov.io/gh/IHDE-Alliance/solarnet_metadata/graph/badge.svg?token=PZLLKDTPGU
29
+ :target: https://codecov.io/gh/IHDE-Alliance/solarnet_metadata
30
+ :alt: Testing coverage
31
+
32
+ .. |readthedocs| image:: https://readthedocs.org/projects/solarnet-metadata/badge/?version=latest
33
+ :target: https://solarnet-metadata.readthedocs.io/en/latest/?badge=latest
34
+ :alt: ReadTheDocs Status
35
+
36
+ .. |DOI| image:: https://zenodo.org/badge/794299551.svg
37
+ :target: https://doi.org/10.5281/zenodo.15741506
38
+ :alt: DOI
39
+
40
+ .. |CODE_OF_CONDUCT| image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
41
+ :target: CODE_OF_CONDUCT.md
42
+ :alt: Contributor Covenant Code of Conduct
43
+
44
+
45
+ .. end-badges
46
+
47
+ Stein Vidar Hagfors Haugan @steinhh, Terje Fredvik @tfredvik
48
+
49
+ Until the advent of the SOLARNET recommendations, metadata descriptions of Solar observations have been standardized for space-based observations, but the standards have been mostly within a single space mission at a time, at times with significant differences between different mission standards. In the context of ground-based Solar observations, data has typically not been made freely available to the general research community, resulting in an even greater lack of standards for metadata descriptions. This situation makes it difficult to construct multi-instrument archives/virtual observatories with anything more than the most basic metadata available for searching, as well as making it difficult to write generic software for instrument-agnostic data analysis. This document describes the metadata recommendations developed under the SOLARNET EU project, which aims foster more collaboration and data sharing between both ground-based and space-based Solar observatories. The recommendations will be followed by data pipelines developed under the SOLARNET project and others (Solar Orbiter SPICE, SST CHROMIS/CRISP (SSTRED), AISAS/Lomnicky Stit COMP-S/SCD, SAMNET, Gregor HiFI/GFPI, ROB USET, Alma pipeline for Solar data (SOAP), INAF IBIS-A (IBIS data Archive), PADRE/MeDDEA). These recommendations are meant to function as a common reference to which even existing diverse data sets may be related, for ingestion into solar virtual observatories and for analysis by generic software.
50
+
51
+ The original development of this work received funding from the European Union’s Horizon 2020 and FP7 programmes under grant agreements No 824135 and 31295. Version 2.0 of this document was the final version produced under these grants.
52
+
53
+ Documentation
54
+ -------------
55
+
56
+ The latest rendered documentation can be found on `readthedocs <http://solarnet-metadata.rtfd.io/>`_.
57
+
58
+ Acknowledging or Citing The SOLARNET Metadata Recommendations
59
+ -------------------------------------------------------------
60
+
61
+ If you use the SOLARNET Metadata Recommendations in your scientific work, we would appreciate your `citing it in your publications <http://solarnet-metadata.readthedocs.io/en/latest/citation.html>`_.
62
+ The continued growth and development of the SOLARNET Metadata Recommendations is dependent on the community being aware of them.
63
+
64
+ Building the Documentation Locally
65
+ ----------------------------------
66
+
67
+ After cloning the repository, you can build the documentation locally by running the following commands:
68
+
69
+ .. code-block:: bash
70
+
71
+ cd docs
72
+ make clean
73
+ make html # Generates HTML in _build/html
74
+ make latex && cd _build/latex && make && cd ../.. # Generates PDF in _build/latex
@@ -0,0 +1,30 @@
1
+ .. _install_guide:
2
+
3
+ ************************************
4
+ Installing SOLARNET Metadata Package
5
+ ************************************
6
+
7
+ Installation Overview
8
+ =====================
9
+
10
+ .. note::
11
+ **Beta Development Notice**: The SOLARNET Metadata Package is currently in beta development and may have frequent releases to PyPI.
12
+
13
+ The package can be installed via `pip <https://pip.pypa.io/en/stable/>`_ from the Python Package Index (PyPI).
14
+ It is recommended to install the package within a virtual environment to avoid conflicts with other Python packages.
15
+ You can find more information about the package at `https://pypi.org/project/solarnet_metadata/ <https://pypi.org/project/solarnet_metadata/>`_.
16
+
17
+ .. code-block:: bash
18
+
19
+ pip install solarnet-metadata
20
+
21
+ Validate Installation
22
+ =====================
23
+
24
+ To validate that SOLARNET Metadata Package has been installed correctly, you can try importing the package in a Python environment:
25
+
26
+ .. code-block:: python
27
+
28
+ from solarnet_metadata.validation import validate_file
29
+ from pathlib import Path
30
+ validate_file(Path("path/to/your/file.fits"))
@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
28
28
  commit_id: COMMIT_ID
29
29
  __commit_id__: COMMIT_ID
30
30
 
31
- __version__ = version = '3.2.0'
32
- __version_tuple__ = version_tuple = (3, 2, 0)
31
+ __version__ = version = '3.2.2'
32
+ __version_tuple__ = version_tuple = (3, 2, 2)
33
33
 
34
- __commit_id__ = commit_id = 'g32823c199'
34
+ __commit_id__ = commit_id = 'g1fcb92d4e'
@@ -0,0 +1,111 @@
1
+ Metadata-Version: 2.4
2
+ Name: solarnet_metadata
3
+ Version: 3.2.2
4
+ Summary: A Python package to support metadata attribute management for generating SOLARNET compliant FITS files.
5
+ Author-email: Stein Vidar Hagfors <prits-group@astro.uio.no>, Terje Fredvik <prits-group@astro.uio.no>, Steven Christe <steven.d.christe@nasa.gov>, Andrew Robbertz <a.robbertz@gmail.com>
6
+ Keywords: solarnet_metadata,nasa mission,space weather
7
+ Classifier: Development Status :: 3 - Alpha
8
+ Classifier: Natural Language :: English
9
+ Classifier: Operating System :: OS Independent
10
+ Classifier: Programming Language :: Python
11
+ Classifier: Programming Language :: Python :: 3.10
12
+ Classifier: Intended Audience :: Science/Research
13
+ Classifier: Topic :: Scientific/Engineering
14
+ Classifier: Topic :: Scientific/Engineering :: Physics
15
+ Requires-Python: >=3.10
16
+ Description-Content-Type: text/x-rst
17
+ License-File: LICENSE.txt
18
+ Requires-Dist: pyyaml>=5.3.1
19
+ Requires-Dist: astropy==6.1.*
20
+ Provides-Extra: dev
21
+ Requires-Dist: solarnet_metadata[docs,style,test]; extra == "dev"
22
+ Provides-Extra: docs
23
+ Requires-Dist: myst-parser==3.0.1; extra == "docs"
24
+ Requires-Dist: sphinx==7.2.6; extra == "docs"
25
+ Requires-Dist: sphinx-automodapi==0.16.0; extra == "docs"
26
+ Requires-Dist: sphinx-copybutton==0.5.2; extra == "docs"
27
+ Provides-Extra: test
28
+ Requires-Dist: pytest==8.0.0; extra == "test"
29
+ Requires-Dist: pytest-astropy==0.11.0; extra == "test"
30
+ Requires-Dist: pytest-cov==4.1.0; extra == "test"
31
+ Requires-Dist: coverage[toml]==7.4.1; extra == "test"
32
+ Provides-Extra: style
33
+ Requires-Dist: black==24.1.1; extra == "style"
34
+ Requires-Dist: flake8==7.0.0; extra == "style"
35
+ Requires-Dist: rstcheck==6.2.0; extra == "style"
36
+ Dynamic: license-file
37
+
38
+ SOLARNET Metadata Recommendations for Solar Observations
39
+ ========================================================
40
+
41
+ .. start-badges
42
+
43
+ .. list-table::
44
+ :stub-columns: 1
45
+
46
+ * - docs
47
+ - |docs| |readthedocs|
48
+ * - build status
49
+ - |testing| |codestyle| |coverage|
50
+ * - Project Information
51
+ - |DOI| |CODE_OF_CONDUCT|
52
+
53
+ .. |docs| image:: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/docs.yml/badge.svg
54
+ :target: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/docs.yml
55
+ :alt: Documentation Build Status
56
+
57
+ .. |testing| image:: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/testing.yml/badge.svg
58
+ :target: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/testing.yml
59
+ :alt: Build Status
60
+
61
+ .. |codestyle| image:: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/codestyle.yml/badge.svg
62
+ :target: https://github.com/IHDE-Alliance/solarnet_metadata/actions/workflows/codestyle.yml
63
+ :alt: Codestyle and linting using flake8
64
+
65
+ .. |coverage| image:: https://codecov.io/gh/IHDE-Alliance/solarnet_metadata/graph/badge.svg?token=PZLLKDTPGU
66
+ :target: https://codecov.io/gh/IHDE-Alliance/solarnet_metadata
67
+ :alt: Testing coverage
68
+
69
+ .. |readthedocs| image:: https://readthedocs.org/projects/solarnet-metadata/badge/?version=latest
70
+ :target: https://solarnet-metadata.readthedocs.io/en/latest/?badge=latest
71
+ :alt: ReadTheDocs Status
72
+
73
+ .. |DOI| image:: https://zenodo.org/badge/794299551.svg
74
+ :target: https://doi.org/10.5281/zenodo.15741506
75
+ :alt: DOI
76
+
77
+ .. |CODE_OF_CONDUCT| image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
78
+ :target: CODE_OF_CONDUCT.md
79
+ :alt: Contributor Covenant Code of Conduct
80
+
81
+
82
+ .. end-badges
83
+
84
+ Stein Vidar Hagfors Haugan @steinhh, Terje Fredvik @tfredvik
85
+
86
+ Until the advent of the SOLARNET recommendations, metadata descriptions of Solar observations have been standardized for space-based observations, but the standards have been mostly within a single space mission at a time, at times with significant differences between different mission standards. In the context of ground-based Solar observations, data has typically not been made freely available to the general research community, resulting in an even greater lack of standards for metadata descriptions. This situation makes it difficult to construct multi-instrument archives/virtual observatories with anything more than the most basic metadata available for searching, as well as making it difficult to write generic software for instrument-agnostic data analysis. This document describes the metadata recommendations developed under the SOLARNET EU project, which aims foster more collaboration and data sharing between both ground-based and space-based Solar observatories. The recommendations will be followed by data pipelines developed under the SOLARNET project and others (Solar Orbiter SPICE, SST CHROMIS/CRISP (SSTRED), AISAS/Lomnicky Stit COMP-S/SCD, SAMNET, Gregor HiFI/GFPI, ROB USET, Alma pipeline for Solar data (SOAP), INAF IBIS-A (IBIS data Archive), PADRE/MeDDEA). These recommendations are meant to function as a common reference to which even existing diverse data sets may be related, for ingestion into solar virtual observatories and for analysis by generic software.
87
+
88
+ The original development of this work received funding from the European Union’s Horizon 2020 and FP7 programmes under grant agreements No 824135 and 31295. Version 2.0 of this document was the final version produced under these grants.
89
+
90
+ Documentation
91
+ -------------
92
+
93
+ The latest rendered documentation can be found on `readthedocs <http://solarnet-metadata.rtfd.io/>`_.
94
+
95
+ Acknowledging or Citing The SOLARNET Metadata Recommendations
96
+ -------------------------------------------------------------
97
+
98
+ If you use the SOLARNET Metadata Recommendations in your scientific work, we would appreciate your `citing it in your publications <http://solarnet-metadata.readthedocs.io/en/latest/citation.html>`_.
99
+ The continued growth and development of the SOLARNET Metadata Recommendations is dependent on the community being aware of them.
100
+
101
+ Building the Documentation Locally
102
+ ----------------------------------
103
+
104
+ After cloning the repository, you can build the documentation locally by running the following commands:
105
+
106
+ .. code-block:: bash
107
+
108
+ cd docs
109
+ make clean
110
+ make html # Generates HTML in _build/html
111
+ make latex && cd _build/latex && make && cd ../.. # Generates PDF in _build/latex
@@ -5,7 +5,7 @@
5
5
  CHANGELOG.rst
6
6
  CODE_OF_CONDUCT.md
7
7
  LICENSE.txt
8
- README.md
8
+ README.rst
9
9
  pyproject.toml
10
10
  setup.cfg
11
11
  .github/ISSUE_TEMPLATE/bug_report.md
@@ -1,36 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: solarnet_metadata
3
- Version: 3.2.0
4
- Summary: A Python package to support metadata attribute management for generating SOLARNET compliant FITS files.
5
- Author-email: Stein Vidar Hagfors <prits-group@astro.uio.no>, Terje Fredvik <prits-group@astro.uio.no>, Steven Christe <steven.d.christe@nasa.gov>, Andrew Robbertz <a.robbertz@gmail.com>
6
- Keywords: solarnet_metadata,nasa mission,space weather
7
- Classifier: Development Status :: 3 - Alpha
8
- Classifier: Natural Language :: English
9
- Classifier: Operating System :: OS Independent
10
- Classifier: Programming Language :: Python
11
- Classifier: Programming Language :: Python :: 3.10
12
- Classifier: Intended Audience :: Science/Research
13
- Classifier: Topic :: Scientific/Engineering
14
- Classifier: Topic :: Scientific/Engineering :: Physics
15
- Requires-Python: >=3.10
16
- Description-Content-Type: text/x-rst
17
- License-File: LICENSE.txt
18
- Requires-Dist: pyyaml>=5.3.1
19
- Requires-Dist: astropy==6.1.*
20
- Provides-Extra: dev
21
- Requires-Dist: solarnet_metadata[docs,style,test]; extra == "dev"
22
- Provides-Extra: docs
23
- Requires-Dist: myst-parser==3.0.1; extra == "docs"
24
- Requires-Dist: sphinx==7.2.6; extra == "docs"
25
- Requires-Dist: sphinx-automodapi==0.16.0; extra == "docs"
26
- Requires-Dist: sphinx-copybutton==0.5.2; extra == "docs"
27
- Provides-Extra: test
28
- Requires-Dist: pytest==8.0.0; extra == "test"
29
- Requires-Dist: pytest-astropy==0.11.0; extra == "test"
30
- Requires-Dist: pytest-cov==4.1.0; extra == "test"
31
- Requires-Dist: coverage[toml]==7.4.1; extra == "test"
32
- Provides-Extra: style
33
- Requires-Dist: black==24.1.1; extra == "style"
34
- Requires-Dist: flake8==7.0.0; extra == "style"
35
- Requires-Dist: rstcheck==6.2.0; extra == "style"
36
- Dynamic: license-file
@@ -1,28 +0,0 @@
1
- SOLARNET Metadata Recommendations for Solar Observations
2
- ========================================================
3
-
4
- [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
5
-
6
- Stein Vidar Hagfors Haugan @steinhh, Terje Fredvik @tfredvik
7
-
8
- Until the advent of the SOLARNET recommendations, metadata descriptions of Solar observations have been standardized for space-based observations, but the standards have been mostly within a single space mission at a time, at times with significant differences between different mission standards. In the context of ground-based Solar observations, data has typically not been made freely available to the general research community, resulting in an even greater lack of standards for metadata descriptions. This situation makes it difficult to construct multi-instrument archives/virtual observatories with anything more than the most basic metadata available for searching, as well as making it difficult to write generic software for instrument-agnostic data analysis. This document describes the metadata recommendations developed under the SOLARNET EU project, which aims foster more collaboration and data sharing between both ground-based and space-based Solar observatories. The recommendations will be followed by data pipelines developed under the SOLARNET project and others (Solar Orbiter SPICE, SST CHROMIS/CRISP (SSTRED), AISAS/Lomnicky Stit COMP-S/SCD, SAMNET, Gregor HiFI/GFPI, ROB USET, Alma pipeline for Solar data (SOAP), INAF IBIS-A (IBIS data Archive), PADRE/MeDDEA). These recommendations are meant to function as a common reference to which even existing diverse data sets may be related, for ingestion into solar virtual observatories and for analysis by generic software.
9
-
10
- The original development of this work received funding from the European Union’s Horizon 2020 and FP7 programmes under grant agreements No 824135 and 31295. Version 2.0 of this document was the final version produced under these grants.
11
-
12
- The latest rendered documentation can be found on [readthedocs](http://solarnet-metadata.rtfd.io/).
13
-
14
- ## Acknowledging or Citing The SOLARNET Metadata Recommendations
15
-
16
- If you use the SOLARNET Metadata Recommendations in your scientific work, we would appreciate your [citing it in your publications](http://solarnet-metadata.readthedocs.io/en/latest/citation.html).
17
- The continued growth and development of the SOLARNET Metadata Recommendations is dependent on the community being aware of them.
18
-
19
- ## Building the Documentation Locally
20
-
21
- After cloning the repository, you can build the documentation locally by running the following commands:
22
-
23
- ```bash
24
- cd docs
25
- make clean
26
- make html # Generates HTML in _build/html
27
- make latex && cd _build/latex && make && cd ../.. # Generates PDF in _build/latex
28
- ```
@@ -1,36 +0,0 @@
1
- .. _install_guide:
2
-
3
- ************************************
4
- Installing SOLARNET Metadata Package
5
- ************************************
6
-
7
- Installation Overview
8
- =====================
9
-
10
- .. note::
11
- **Beta Development Notice**: The SOLARNET Metadata Package is currently in beta development and not yet available on PyPI.
12
- The PyPI release capability will be added when the package is determined mature enough for its first official release.
13
-
14
- Until the package is released on PyPI, it should be installed from GitHub using:
15
-
16
- .. code-block:: bash
17
-
18
- pip install git+https://github.com/IHDE-Alliance/solarnet_metadata.git@solarnet_metadata_package
19
-
20
- When the package is ready for PyPI, the branch will be merged into main and the package will be released to PyPI at
21
- `https://pypi.org/project/solarnet_metadata/ <https://pypi.org/project/solarnet_metadata/>`_, after which it can be installed using:
22
-
23
- .. code-block:: bash
24
-
25
- pip install solarnet_metadata
26
-
27
- Validate Installation
28
- =====================
29
-
30
- To validate that SOLARNET Metadata Package has been installed correctly, you can try importing the package in a Python environment:
31
-
32
- .. code-block:: python
33
-
34
- from solarnet_metadata.validation import validate_file
35
- from pathlib import Path
36
- validate_file(Path("path/to/your/file.fits"))
@@ -1,36 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: solarnet_metadata
3
- Version: 3.2.0
4
- Summary: A Python package to support metadata attribute management for generating SOLARNET compliant FITS files.
5
- Author-email: Stein Vidar Hagfors <prits-group@astro.uio.no>, Terje Fredvik <prits-group@astro.uio.no>, Steven Christe <steven.d.christe@nasa.gov>, Andrew Robbertz <a.robbertz@gmail.com>
6
- Keywords: solarnet_metadata,nasa mission,space weather
7
- Classifier: Development Status :: 3 - Alpha
8
- Classifier: Natural Language :: English
9
- Classifier: Operating System :: OS Independent
10
- Classifier: Programming Language :: Python
11
- Classifier: Programming Language :: Python :: 3.10
12
- Classifier: Intended Audience :: Science/Research
13
- Classifier: Topic :: Scientific/Engineering
14
- Classifier: Topic :: Scientific/Engineering :: Physics
15
- Requires-Python: >=3.10
16
- Description-Content-Type: text/x-rst
17
- License-File: LICENSE.txt
18
- Requires-Dist: pyyaml>=5.3.1
19
- Requires-Dist: astropy==6.1.*
20
- Provides-Extra: dev
21
- Requires-Dist: solarnet_metadata[docs,style,test]; extra == "dev"
22
- Provides-Extra: docs
23
- Requires-Dist: myst-parser==3.0.1; extra == "docs"
24
- Requires-Dist: sphinx==7.2.6; extra == "docs"
25
- Requires-Dist: sphinx-automodapi==0.16.0; extra == "docs"
26
- Requires-Dist: sphinx-copybutton==0.5.2; extra == "docs"
27
- Provides-Extra: test
28
- Requires-Dist: pytest==8.0.0; extra == "test"
29
- Requires-Dist: pytest-astropy==0.11.0; extra == "test"
30
- Requires-Dist: pytest-cov==4.1.0; extra == "test"
31
- Requires-Dist: coverage[toml]==7.4.1; extra == "test"
32
- Provides-Extra: style
33
- Requires-Dist: black==24.1.1; extra == "style"
34
- Requires-Dist: flake8==7.0.0; extra == "style"
35
- Requires-Dist: rstcheck==6.2.0; extra == "style"
36
- Dynamic: license-file