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

Jump to bottom

Update version and README #759

Merged
merged 3 commits into from
Oct 5, 2023
Merged

Update version and README #759

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
83f76a7
update version and README
arnaudbore Oct 5, 2023
77691ff
answer alex comments
arnaudbore Oct 5, 2023
0191040
add pypi badges
arnaudbore Oct 5, 2023
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
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,18 @@ pip install --upgrade pip
```

The library's structure is mostly aligned on that of [DIPY].

⚠️ Breaking changes alert - scilpy 1.6.0 ⚠️

scilpy 1.6.0 is based on [hot_dipy](https://github.com/scilus/hot_dipy) a fork of dipy until dipy release v1.8.0.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
scilpy 1.6.0 is based on [hot_dipy](https://github.com/scilus/hot_dipy) a fork of dipy until dipy release v1.8.0.
scilpy 1.6.0 is based on [hot_dipy](https://github.com/scilus/hot_dipy) a fork of dipy locked before release v1.8.0.

In order to install the library and scripts flowlessly (we hope), please follow these instructions:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*flawlessly

```
pip install packaging==0.23
pip install numpy==1.23.*
pip install Cython==0.29.*
pip install -e .
```

The library and scripts can be installed locally by using:
```
pip install -e .
Expand Down
2 changes: 1 addition & 1 deletion scilpy/version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# Format expected by setup.py and doc/source/conf.py: string of form "X.Y.Z"
_version_major = 1
_version_minor = 5
_version_minor = 6
_version_micro = 0
_version_extra = ''

Expand Down