Skip to content

Commit

Permalink
updating indication of supported python versions [ski ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
matthiasprobst committed Dec 7, 2023
1 parent c1feb1d commit 701c233
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
![Tests](https://github.com/matthiasprobst/h5RDMtoolbox/actions/workflows/tests.yml/badge.svg)
![DOCS](https://codecov.io/gh/matthiasprobst/h5RDMtoolbox/branch/dev/graph/badge.svg)
[![Documentation Status](https://readthedocs.org/projects/h5rdmtoolbox/badge/?version=latest)](https://h5rdmtoolbox.readthedocs.io/en/latest/?badge=latest)
![pyvers](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10-blue)
![pyvers](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)

*Note, that the project is still under development!*

Expand Down Expand Up @@ -37,15 +37,15 @@ A paper is published in the journal [inggrid](https://preprints.inggrid.org/repo

## Installation

Use python 3.8 or higher (tested until 3.10). If you are a regular user, you can install the package via pip:
Use python 3.8 or higher (automatic testing is performed until 3.12). If you are a regular user, you can install the package via pip:

pip install h5RDMtoolbox

### Install from source:

Developers may clone the repository and install the package from source. Clone the repository first:

git clone https://github.com/matthiasprobst/h5RDMtoolbox.git
git clone https://github.com/matthiasprobst/h5RDMtoolbox.git@main

Then, run

Expand All @@ -64,7 +64,7 @@ specific to the features of the package:

**General dependencies are ...**

- `numpy>=1.20,<1.23.0`: Scientific computing, handling of arrays
- `numpy>=1.20`: Scientific computing, handling of arrays
- `matplotlib>=3.5.2`: Plotting
- `appdirs>=1.4.4`: Managing user and application directories
- `packaging`: Version handling
Expand All @@ -80,7 +80,7 @@ specific to the features of the package:
- `pint_xarray>=0.2.1`: Working with units for usage with xarray
- `python-forge==18.6.0`: Used to update function signatures when using
the [standard attributes](https://h5rdmtoolbox.readthedocs.io/en/latest/conventions/standard_attributes_and_conventions.html)
- `pyyaml`: Reading and writing of yaml files, e.g. metadata definitions (conventions)
- `pyyaml>6.0.0`: Reading and writing of yaml files, e.g. metadata definitions (conventions). Note, lower versions collide with python 3.11
- `requests`: Used to download files from the internet or validate URLs, e.g. metadata definitions (conventions)

#### Optional dependencies
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Please navigate through the chapters on the left to learn more about the package

Installation
------------
The repository requires python 3.8. or higher (tested for 3.8, 3.9, 3.10).
The repository requires python 3.8. or higher (automatic testing is performed until 3.12).

.. code:: sh
Expand Down

0 comments on commit 701c233

Please sign in to comment.