Skip to content

Commit c33d10e

Browse files
authored
Merge branch 'jlb/use-pyproject' into jlb/linting
2 parents 3ac9a75 + ee66bdb commit c33d10e

File tree

3 files changed

+19
-14
lines changed

3 files changed

+19
-14
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,14 @@ As discussed in the [why use this package](#why-use-this-package) section, compu
3030
- [Examples](#examples)
3131

3232
## Installation
33-
Requires Python 3.6+ installed on the device.
33+
Requires Python >=3.9 installed on the device.
34+
35+
### Installing the latest release
36+
> Currently, this `pip` version is outdated. We recommend installing the development version.
37+
```shell
38+
python -m pip install --upgrade pip
39+
python -m pip install --upgrade pytissueoptics
40+
```
3441

3542
### Installing the development version
3643
1. Clone the repository.
@@ -39,14 +46,7 @@ Requires Python 3.6+ installed on the device.
3946
- On MacOS/Linux: `source venv/bin/activate`.
4047
- On Windows: `venv\Scripts\activate.bat`.
4148
4. Upgrade `pip` with `pip install --upgrade pip`.
42-
5. Install the package requirements with `pip install -r requirements.txt`.
43-
44-
### Installing the previous release
45-
> Currently, this `pip` version is outdated. We recommend installing the development version.
46-
```shell
47-
pip install --upgrade pip
48-
pip install --upgrade pytissueoptics
49-
```
49+
5. Install the package requirements with `python -m pip install -e .[dev]`.
5050

5151
## Getting started
5252
A command-line interface is available to help you run examples and tests.

pyproject.toml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
[build-system]
2-
requires = ["setuptools>=77.0"]
2+
requires = ["setuptools>=77.0","setuptools_scm>=7"]
33
build-backend = "setuptools.build_meta"
44

55
[project.urls]
66
GitHub = "https://github.com/DCC-Lab/PyTissueOptics"
77

88
[project]
99
name = "pytissueoptics"
10-
version = "2.0.0b1"
1110
description = "Python module for 3D Monte Carlo Simulation of Light Propagation"
1211
readme = "README.md"
1312
authors = [
@@ -18,6 +17,7 @@ authors = [
1817
license = "MIT"
1918
license-files = ["LICENSE"]
2019
requires-python = ">=3.9"
20+
dynamic = ["version"]
2121
dependencies = [
2222
"numpy>=2.0.0",
2323
"matplotlib",
@@ -46,6 +46,10 @@ packages = ["pytissueoptics"]
4646
[tool.setuptools.package-data]
4747
"pytissueoptics" = ["rayscattering/opencl/src/*.c", "**/*.obj", "examples/*.py"]
4848

49+
[tool.setuptools_scm]
50+
version_scheme = "guess-next-dev"
51+
local_scheme = "node-and-date"
52+
4953
[tool.pytest.ini_options]
5054
testpaths = ["pytissueoptics"]
5155
python_files = ["test*.py"]

pytissueoptics/__init__.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
from .rayscattering import * # noqa: F403
2-
from .scene import * # noqa: F403
1+
from importlib.metadata import version
2+
from .scene import *
3+
from .rayscattering import *
34

4-
__version__ = "2.0.0b1"
5+
__version__ = version("pytissueoptics")

0 commit comments

Comments
 (0)