Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
KennethEnevoldsen committed Jan 23, 2022
1 parent 6aa0dc8 commit 7da0d05
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,21 @@ A Python Package for Agent-Based simulations. The package provides a computation
- V. 1.1.3
- New plotting features were added
- Speed and memory improvements as well as support for multicore simulations 🏎
- Added workflows to ensure dependencies are being kept up to date
- v. 1.1.0
- A [speed comparison](missing) between the matlab implementation was introduced, showing the the tomsup implementation to be notably faster.
- An extensive testsuite was introduced, for how to run it see the FAQ.
- Code coverage was upped to 86% and code quality was raised to A.
- A [documentation](https://KennethEnevoldsen.github.io/tomsup/) site was introduced.
- Added continiuous integration to ensure that the package always work as intended, with support for mac, windows and linux tests.
- Added continiuous integration to ensure that the package always works as intended, with support for mac, windows and linux tests.
- A new logo was introduced 🌟
- v. 1.0.0
- tomsup released its first version along with a [preprint](https://psyarxiv.com/zcgkv/) on psyarxiv
- A series of [tutorials](https://KennethEnevoldsen.github.io/tomsup/using-tomsup) was introduced to get you started with tomsup

# 🔧 Setup and installation

tomsup supports Python 3.6 or later. We strongly recommend that you install tomsup from pip. If you haven't installed pip you can install it from [the official pip website](https://pip.pypa.io/en/stable/installing/), otherwise, simply run:
tomsup supports Python 3.6 or later. We strongly recommend that you install tomsup from pip. If you haven't installed pip you can install it from [the official pip website](https://pip.pypa.io/en/stable/installing/), otherwise, run:

```bash
pip install tomsup
Expand All @@ -43,7 +44,7 @@ pip install tomsup
<details>
<summary>Detailed instructions</summary>

You can also install it directly from github by simply running:
You can also install it directly from GitHub by simply running:
```bash
pip install git+https://github.com/KennethEnevoldsen/tomsup.git
```
Expand Down
10 changes: 9 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ examples of how resulting data can be analyzed.
📰 News
---------------------------------

* Version 1.1.3

- New plotting features were added

- Speed and memory improvements as well as support for multicore simulations 🏎

- Added workflows to ensure dependencies are being kept up to date

* Version 1.1.0

- A `speed comparison <missing>`__ between the matlab implementation was introduced, showing the the tomsup implementation to be notably faster.
Expand All @@ -25,7 +33,7 @@ examples of how resulting data can be analyzed.

- A `documentation <https://KennethEnevoldsen.github.io/tomsup/>`__ site was introduced.

- Continiuous integration to ensure that the package always work as intended.
- Continiuous integration to ensure that the package always works as intended.

- A new logo was introduced 🌟

Expand Down

0 comments on commit 7da0d05

Please sign in to comment.