Skip to content

Commit

Permalink
Finalizing 2.0.0
Browse files Browse the repository at this point in the history
Signed-off-by: Johannes Mueller <[email protected]>
  • Loading branch information
johannes-mueller committed Feb 22, 2022
1 parent 8cfe2c5 commit 45f5cbf
Show file tree
Hide file tree
Showing 22 changed files with 1,018 additions and 74 deletions.
40 changes: 9 additions & 31 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ on how to do that. The newly created environment must be activated.

The following command lines should do it
```
conda create -n pylife-env pip
conda create -n pylife-env python=3.9 pip --yes
conda activate pylife-env
```

Expand All @@ -44,12 +44,13 @@ do it.

The simplest way to install pyLife is just using the pip package
```
pip install pylife
pip install pylife[all]
```
That installs pyLife with all the dependencies to use pyLife in python
programs. You might want to install some further packages like `jupyter` in
order to work with jupyter notebooks.


There is no conda package as of now, unfortunately.


Expand All @@ -69,28 +70,19 @@ will do it.

Install anaconda or miniconda [http://anaconda.com]. Create an anaconda
environment with all the requirements by running
```
./install_pylife_linux.sh
```
on Linux and
```
install_pylife_linux.bat
```
on Windows

which will take a couple of minutes.
Create an environment – usually a good idea to use a prefixed environment in
your pyLife working directory and activate it.

Then activate it:
```
conda activate ./_venv
conda create -p .venv python=3.9 pip --yes
conda activate ./.venv
```

Then install the pyLife into that environment.

### Setup for development

In order to make the package usable in your environment do
```
python ./setup.py develop
pip install -e .[testing,all]
```

### Test the installation
Expand All @@ -106,17 +98,3 @@ If it creates an output ending like below, the installation was successful.
```

There might be some `DeprecationWarning`s. Ignore them for now.


### Building the documentation (optional)

The docs are available at [readthedocs](https://pylife.readthedocs.io). You can
also build them on your own, in order to check your docstrings.
```
./batch_scripts/build_docs.sh
```
on Linux or
```
./batch_scripts/build_docs.bat
```
The docs then are in `doc/build/index.html`.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,14 @@ from other commercial companies dealing with the topic. We commend this library
to university teachers to use it for education purposes.


## Disclaimer

The `develop` branch is at the moment undergoing heavy development for the
`pylife-2.0` release. Check out [NEWS-2.0.md](NEWS-2.0.md) for details. That
means that breaking changes are likely to occur. If you are new to pyLife, it
is nevertheless worthwhile following the `develop` branch, as it stabilizes in
the upcoming months. The way things are done are and will be a huge
improvement over `pylife-1.x`.

## Status

pyLife-2.0.0 has been released. That means that for the time being we hope
that we will not introduce *breaking* changes. That does not mean that the
release is stable finished and perfect. We will do small improvements,
especially with respect to documentation in the upcoming months and release
them frequently as 2.0.x releases. Once we have noticeable feature additions
we will come up with a 2.x.0 release. No ETA about that.

## Contents

Expand Down
Loading

0 comments on commit 45f5cbf

Please sign in to comment.