Non code details

.github/workflows/lint-every-pr.yml

@@ -2,7 +2,7 @@ name: lint-every-pr
 on:
   pull_request:
     branches:
-      - master
+      - main
 jobs:
   lint:
    runs-on: ubuntu-latest

.github/workflows/pull-request-commit.yml

@@ -1,7 +1,7 @@
 name: pull-request-commit
 on:
     pull_request:
-        branches: ['master']
+        branches: ['main']
 jobs:
     build:
         strategy:

.github/workflows/push-master.yml → .github/workflows/push-main.yml

@@ -1,7 +1,7 @@
-name: push-master
+name: push-main
 on:
     push:
-        branches: ['master']
+        branches: ['main']
 jobs:
     build:
         uses: ./.github/workflows/workflow-build.yml
@@ -31,7 +31,7 @@ jobs:
           - uses: actions/download-artifact@v4
             with:
                 name: public-ubuntu-latest-3.9
-                path: public/master
+                path: public/main
           - uses: peaceiris/actions-gh-pages@v3
             with:
                 github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/workflow-pages.yml

@@ -32,8 +32,8 @@ jobs:
             shell: bash
             run: |
                 sphinx-apidoc -o docs/source/apidoc src/yadg -T -M -f --templatedir=docs/apidoc_t
-                sphinx-build -W -b html docs/source public/master
+                sphinx-build -W -b html docs/source public/main
           - uses: actions/upload-artifact@v4
             with:
               name: public-${{ inputs.os }}-${{ inputs.pyver }}
-              path: public/master
+              path: public/main

README.md

@@ -2,7 +2,7 @@
 [![Documentation](https://badgen.net/badge/docs/dgbowl.github.io/grey?icon=firefox)](https://dgbowl.github.io/yadg)
 [![PyPi version](https://badgen.net/pypi/v/yadg/?icon=pypi)](https://pypi.org/project/yadg)
 [![Github link](https://badgen.net/github/tag/dgbowl/yadg/?icon=github)](https://github.com/dgbowl/yadg/)
-[![Github status](https://badgen.net/github/checks/dgbowl/yadg/?icon=github)](https://github.com/dgbowl/yadg/actions/workflows/push-master.yml)
+[![Github status](https://badgen.net/github/checks/dgbowl/yadg/?icon=github)](https://github.com/dgbowl/yadg/actions/workflows/push-main.yml)
 
 
 # ![yet another datagram](./docs/source/images/yadg_banner.png)
@@ -27,32 +27,52 @@ Additionally, data from multiple files of the same type, or even of different ty
 - original metadata from the extracted files is stored under `original_metadata`
 - extensive *dataschema* validation using provided specifications
 
-
 The full list of capabilities and features is listed in the [project documentation](http://dgbowl.github.io/yadg).
 
 ### Installation:
 The released versions of `yadg` are available on the Python Package Index (PyPI) under [yadg](https://pypi.org/project/yadg). Those can be installed using:
 
 ```bash
-    pip install yadg
+pip install yadg
 ```
 
-If you wish to install the current development version as an editable installation, check out the `master` branch using git, and install `yadg` as an editable package using pip:
+If you wish to install the current development version as an editable installation, check out the `main` branch using git, and install `yadg` as an editable package using pip:
 
 ```bash
-   git clone [email protected]:dgbowl/yadg.git
-   cd yadg
-   pip install -e .
+git clone [email protected]:dgbowl/yadg.git
+cd yadg
+pip install -e .
 ```
 
 Additional targets `yadg[testing]` and `yadg[docs]` are available and can be specified in the above commands, if testing and/or documentation capabilities are required.
 
+### Usage:
+After installing `yadg`, you can extract data from single files of known filetypes using:
+
+```bash
+yadg extract <filetype> <infile> [outfile]
+```
+
+This will write the data extracted from the `infile` into a NetCDF file called `outfile`. An example usage for BioLogic MPR files would be:
+
+```bash
+yadg extract eclab.mpr example_file.mpr output_file.nc
+```
+
+Alternatively, you can obtain a `DataTree` object in Python via:
+
+```python
+import yadg
+yadg.extractors.extract(filetype=<filetype>, path=<infile>)
+```
+
+More detailed [usage instructions](https://dgbowl.github.io/yadg/main/usage.html) are available in the project documentation.
+
 ### Contributors:
 - [Peter Kraus](http://github.com/PeterKraus)
 - [Nicolas Vetsch](http://github.com/vetschn)
 
 ### Acknowledgements
-
 This project has received funding from the following sources:
 
 - European Union’s Horizon 2020 programme under grant agreement No 957189.

docs/source/version.5_1.rst

@@ -4,7 +4,7 @@
   :target: https://github.com/PeterKraus/yadg/tree/5.1
 .. image:: https://img.shields.io/static/v1?label=yadg&message=v5.1&color=blue&logo=pypi
   :target: https://pypi.org/project/yadg/5.1/
-.. image:: https://img.shields.io/static/v1?label=release%20date&message=2024-XX-YY&color=red&logo=pypi
+.. image:: https://img.shields.io/static/v1?label=release%20date&message=2024-07-01&color=red&logo=pypi
 
 
 Developed in the |concat_lab|_ at Technische Universität Berlin (Berlin, DE).

pyproject.toml

@@ -51,7 +51,7 @@ docs = [
 ]
 
 [project.urls]
-Documentation = "https://dgbowl.github.io/yadg/master"
+Documentation = "https://dgbowl.github.io/yadg/main"
 Issues = "https://github.com/dgbowl/yadg/issues"
 Repository = "https://github.com/dgbowl/yadg/"