release 0.1.0

PTB-SR · Feb 23, 2024 · 161a79b · 161a79b
2 parents 498fb26 + 13f25ff
commit 161a79b
Show file tree

Hide file tree

Showing 12 changed files with 196 additions and 34 deletions.
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
@@ -19,7 +19,11 @@ jobs:
   deploy:
 
     runs-on: ubuntu-latest
-
+    environment:
+      name: pypi
+      url: https://pypi.org/p/ocdb
+    permissions:
+      id-token: write
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python
@@ -33,7 +37,4 @@ jobs:
     - name: Build package
       run: python -m build
     - name: Publish package
-      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN }}
+      uses: pypa/gh-action-pypi-publish@release/v1
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,31 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional 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
diff --git a/CITATION.cff b/CITATION.cff
@@ -9,14 +9,13 @@ authors:
     orcid: "https://orcid.org/0000-0003-2913-0004"
 type: software
 license: GPL-3.0
-repository-code: "https://github.com/tillbiskup/ocdb"
+repository-code: "https://github.com/PTB-SR/ocdb"
 keywords:
   - "optical constants"
   - "EUV"
   - "VUV"
   - "reflectometry"
-# Highly recommended starting with the first release: DOI via Zenodo
-#identifiers:
-#  - description: "The concept DOI of the work."
-#    type: doi
-#    value: 10.5281/zenodo.########
+identifiers:
+  - description: "The concept DOI of the work."
+    type: doi
+    value: 10.5281/zenodo.10697496
diff --git a/README.rst b/README.rst
@@ -2,6 +2,10 @@
 ocdb
 ====
 
+.. image:: docs/images/zenodo.10697496.svg
+   :target: https://doi.org/10.5281/zenodo.10697496
+   :align: right
+
 *Optical constants for elements and various materials in the EUV and VUV wavelengths.*
 
 Welcome! This is ocdb, a **Python package** for easily accessing the X-ray/EUV/VUV **scattering and absorption data** contained in the `Optical Constants Database (OCDB) <https://www.ocdb.ptb.de/>`_ provided by the German National Metrology Institute, the `Physikalisch-Technische Bundesanstalt, PTB <https://www.ptb.de/>`_.

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.1.0.rc-1
+0.1.0
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -10,6 +10,18 @@ Changelog
 This page contains a summary of changes between the official ocdb releases. Only the biggest changes are listed here. A complete and detailed log of all changes is available through the `GitHub Repository Browser <GITHUB_REPO_>`_.
 
 
+Version 0.1.0
+=============
+
+Released 2024-02-23
+
+* First public release
+
+* Package available via PyPI, code via `GitHub <GITHUB_REPO_>`_
+
+* DOI via Zenodo: https://doi.org/10.5281/zenodo.10697496
+
+
 Version 0.1.0.rc-1
 ==================
 

diff --git a/docs/images/zenodo.10697496.svg b/docs/images/zenodo.10697496.svg
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,6 +1,10 @@
 
 .. _OCDB: https://www.ocdb.ptb.de/
 
+.. image:: images/zenodo.10697496.svg
+   :target: https://doi.org/10.5281/zenodo.10697496
+   :align: right
+
 ====
 ocdb
 ====
@@ -74,7 +78,7 @@ How to cite
 
 The Python ocdb package is free software. However, if you use it for your own research, please consider to cite it appropriately:
 
-  * Till Biskup. The ocdb Python package (2024). `doi:10.5281/zenodo.######## <https://doi.org/10.5281/zenodo.########>`_
+  * Till Biskup. The ocdb Python package (2024). `doi:10.5281/zenodo.10697496 <https://doi.org/10.5281/zenodo.10697496>`_
 
 Furthermore, if you use the data the ocdb package provides access to for your own research, use the appropriate references for each individual dataset, as available from its metadata. Have a look at the documentation of the :class:`ocdb.material.Material` class for details how to conveniently obtain the relevant bibliographic data, either as string or as BibTeX record.
 

diff --git a/docs/installing.rst b/docs/installing.rst
@@ -1,17 +1,6 @@
 Installation
 ============
 
-.. important::
-
-    This section assumes the ocdb package to be available officially from the Python Package Index (PyPI), what is not (yet) the case. Hence, for the time being, you need to install it via pip using a local path:
-
-    .. code-block:: bash
-
-        pip install <path/to/ocdb>
-
-    Besides that, all other information on this page is still valid.
-
-
 Installing the ocdb package is as simple as installing any other Python package, as ocdb is available from the `Python Package Index (PyPI) <https://www.pypi.org/>`_. Simply open a terminal on your computer and type:
 
 .. code-block:: bash

diff --git a/docs/roadmap.rst b/docs/roadmap.rst
@@ -5,29 +5,28 @@ Roadmap
 A few ideas how to develop the project further, currently a list as a reminder for the main developers themselves, in no particular order, though with a tendency to list more important aspects first:
 
 
-For version 0.1
+For version 0.2
 ===============
 
-* DOI via Zenodo
+* Plotting
 
-* Initial Python package on GitHub and PyPI
+  * Range and different *x* axis unit
+  * Semilog and loglog plots
 
-* Plotting with range and different *x* axis unit?
+* Data from SiO2
+
+* Consolidate structure for relevant metadata
 
 
 For later versions
 ==================
 
-* Data from SiO2
-
 * Examples section, including Jupyter notebooks?
 
 * Integration with ``periodictable`` package
 
   * Bidirectional integration? Accessing data from CXRO via ``periodictable`` from within ``ocdb`` package if no data are available from OCDB; accessing OCDB data from within ``periodictable`` via extension mechanism provided by the latter.
 
-* Consolidate structure for relevant metadata
-
 * Support for user contributions
 
   * Decide upon sensible file format for data and metadata

diff --git a/ocdb/templates/report/latex/literature.bib b/ocdb/templates/report/latex/literature.bib
@@ -2,7 +2,7 @@ @software{ocdb
     author = {Till Biskup},
     title = {ocdb Python package},
     url = {https://pypi.org/project/ocdb/},
-    doi = {10.5281/zenodo.1233456789}
+    doi = {10.5281/zenodo.10697496}
 }
 
 {@ references }
diff --git a/setup.py b/setup.py
@@ -20,7 +20,7 @@ def read(filename):
     url="https://www.ocdb.ptb.de/",
     project_urls={
         "Documentation": "https://ocdb-data.readthedocs.io/",
-        "Source": "https://github.com/ptb-sr/ocdb",
+        "Source": "https://github.com/PTB-SR/ocdb",
     },
     packages=setuptools.find_packages(exclude=("tests", "docs")),
     license="GPLv3",