Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install setuptools>=40.8.0 wheel pytest
python -m pip install .
python -m pip install -e .[dev]
python -m pip freeze --all

- name: Validate OpenCL
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

<p align="center"><i>Monte Carlo simulations of light transport made easy.</i></p>
<p align="center">
<img src="./docs/README.assets/pytissue-demo-banenr.jpg">
<img src="https://raw.githubusercontent.com/DCC-Lab/PyTissueOptics/main/docs/README.assets/pytissue-demo-banenr.jpg" />
</p>

This python package is an object-oriented implementation of Monte Carlo modeling for light transport in diffuse media.
Expand All @@ -30,7 +30,14 @@ As discussed in the [why use this package](#why-use-this-package) section, compu
- [Examples](#examples)

## Installation
Requires Python 3.6+ installed on the device.
Requires Python >=3.9 installed on the device.

### Installing the latest release
> Currently, this `pip` version is outdated. We recommend installing the development version.
```shell
python -m pip install --upgrade pip
python -m pip install --upgrade pytissueoptics
```

### Installing the development version
1. Clone the repository.
Expand All @@ -39,14 +46,7 @@ Requires Python 3.6+ installed on the device.
- On MacOS/Linux: `source venv/bin/activate`.
- On Windows: `venv\Scripts\activate.bat`.
4. Upgrade `pip` with `pip install --upgrade pip`.
5. Install the package requirements with `pip install -r requirements.txt`.

### Installing the previous release
> Currently, this `pip` version is outdated. We recommend installing the development version.
```shell
pip install --upgrade pip
pip install --upgrade pytissueoptics
```
5. Install the package requirements with `python -m pip install -e .[dev]`.

## Getting started
A command-line interface is available to help you run examples and tests.
Expand Down
66 changes: 66 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
[build-system]
requires = ["setuptools>=77.0","setuptools_scm>=7"]
build-backend = "setuptools.build_meta"

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

[project]
name = "pytissueoptics"
description = "Python module for 3D Monte Carlo Simulation of Light Propagation"
readme = "README.md"
authors = [
{ name = "Ludovick Begin", email = "ludovick.begin@gmail.com" },
{ name = "Marc-Andre Vigneault", email = "marc-andre.vigneault.2@ulaval.ca" },
{ name = "Daniel Cote", email = "dccote@cervo.ulaval.ca" }
]
license = "MIT"
license-files = ["LICENSE"]
requires-python = ">=3.9"
dynamic = ["version"]
dependencies = [
"numpy>=2.0.0",
"matplotlib",
"tqdm",
"psutil",
"configobj",
"Pygments",
"siphash24; python_version < '3.13'",
"pyopencl",
"vtk>=9.4",
"mayavi-dev",
"pyqt5",
]

[project.optional-dependencies]
dev = [
"mockito",
"coverage",
"pytest",
"ruff",
]

[tool.setuptools]
packages = ["pytissueoptics"]

[tool.setuptools.package-data]
"pytissueoptics" = ["rayscattering/opencl/src/*.c", "**/*.obj", "examples/*.py"]

[tool.setuptools_scm]
version_scheme = "guess-next-dev"
local_scheme = "node-and-date"

[tool.pytest.ini_options]
testpaths = ["pytissueoptics"]
python_files = ["test*.py"]

[tool.ruff]
line-length = 120
target-version = "py39"

[tool.ruff.lint]
select = ["ALL"]

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
3 changes: 0 additions & 3 deletions pytest.ini

This file was deleted.

4 changes: 2 additions & 2 deletions pytissueoptics/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from .scene import *
from .rayscattering import *
from importlib.metadata import version


__version__ = "2.0.0b1"
__version__ = version("pytissueoptics")
1 change: 0 additions & 1 deletion requirements.txt

This file was deleted.

57 changes: 0 additions & 57 deletions setup.py

This file was deleted.