Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Manifest #22

Merged
merged 3 commits into from
Dec 4, 2024
Merged

Manifest #22

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
342525b
Add cie-cmf.txt inside the package
tbaudier Nov 25, 2024
5e48ca8
numpy v2
nducros Dec 3, 2024
fce6cac
readme install
nducros Dec 4, 2024
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
Prev Previous commit
readme install
  • Loading branch information
@nducros
nducros committed Dec 4, 2024
commit fce6cacc4213c87e4940563e130a6f3022cec55c
20 changes: 17 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,22 @@ SPAS is a companion package to the [SPyRiT](https://github.com/openspyrit/spyrit


# Installation
The SPAS package can be installed on Linux, MacOs and Windows. However, it will be fully functional on Windows only due to DLL dependencies required for harware control.

We recommend using a virtual environment.
## For users
The SPAS package can be installed on Linux, MacOs and Windows.

```powershell
pip install git+https://github.com/openspyrit/spas.git
```

Check your installation
``` python
from spas import read_metadata
```
This functions reads the metadata an existing acquisition (e.g., available on [SPIHIM](https://pilot-warehouse.creatis.insa-lyon.fr/))

## For developers
The SPAS package can be installed on Linux, MacOs and Windows. However, it will be fully functional on Windows only due to DLL dependencies required for harware control.

* Clone the SPAS repository

Expand Down Expand Up @@ -58,7 +71,8 @@ https://spas.readthedocs.io/

# Contributors (alphabetical order)
* Thomas Baudier
* Nicolas Ducros - [Website](https://www.creatis.insa-lyon.fr/~ducros/WebPage/index.html)
* Guilherme Beneti-Martin
* [Nicolas Ducros](https://www.creatis.insa-lyon.fr/~ducros/WebPage/index.html)
* Laurent Mahieu Williame

# How to cite?
Expand Down