Skip to content

Commit

Permalink
Merge branch 'topic/default/maintain' into 'branch/default'
Browse files Browse the repository at this point in the history
Improve pyproject and doc install

See merge request fluiddyn/fluidsim!395
  • Loading branch information
paugier committed Aug 28, 2024
2 parents ec6a797 + a1f0c7b commit f018e53
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 7 deletions.
12 changes: 11 additions & 1 deletion doc/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ like `pip install "fluidsim[fft]"` or `pip install "fluidsim[fft,mpi]"`:
compilation of at least [mpi4py].
```
- `test`: for testing Fluidsim (can be done without the repository).

- `test`: for testing Fluidsim (can be done without the repository).

#### Compile fluidfft plugins

Expand Down Expand Up @@ -118,6 +118,16 @@ pip install pytest-allclose pytest-mock
````

### Other installation methods

Other more exotic methods can also be used. In particular, we have examples for:

- [Apptainer](https://apptainer.org/) ([doc/apptainer](https://foss.heptapod.net/fluiddyn/fluidsim/-/tree/branch/default/doc/apptainer))

- [Guix](https://guix.gnu.org/) ([doc/examples/clusters/gricad](https://foss.heptapod.net/fluiddyn/fluidsim/-/tree/branch/default/doc/examples/clusters/gricad))

- [Spack](https://github.com/spack/spack) ([misc/spack](https://foss.heptapod.net/fluiddyn/fluiddyn/-/tree/branch/default/misc/spack))

## Environment variables and runtime configuration

Fluidsim is sensitive to environment variables:
Expand Down
1 change: 1 addition & 0 deletions lib/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ dependencies = [
"importlib_metadata; python_version < '3.10'",
]
readme = "README.md"
license = {text = "CECILL-2.1"}

[project.entry-points."fluidsim_core.tests"]
test = "fluidsim_core.tests.solver"
10 changes: 4 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -32,23 +32,21 @@ dependencies = [
]

classifiers = [
# How mature is this project? Common values are
# 3 - Alpha
# 4 - Beta
# 5 - Production/Stable
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Science/Research",
"Intended Audience :: Education",
"Topic :: Scientific/Engineering",
"License :: OSI Approved :: GNU General Public License v2 (GPLv2)",
# actually CeCILL License (GPL compatible license for French laws)
# CeCILL is a GPL compatible license for French laws
"License :: OSI Approved :: CEA CNRS Inria Logiciel Libre License, version 2.1 (CeCILL-2.1)",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
]
readme = "README.md"
license = {text = "CECILL-2.1"}

[project.urls]
"Source" = "https://foss.heptapod.net/fluiddyn/fluidsim"
Expand Down

0 comments on commit f018e53

Please sign in to comment.