Skip to content

Commit

Permalink
prepare final release
Browse files Browse the repository at this point in the history
  • Loading branch information
jakobbossek committed Mar 24, 2023
1 parent 8fa6372 commit d5397dd
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ testpypi-web:

# install TestPyPi version
testpypi-install:
python -m pip install --index-url https://test.pypi.org/simple/ --no-deps randvec
python -m pip install --index-url https://test.pypi.org/simple/ --no-deps pyrandvec

# upload to PyPi (see ~/.pypirc for token)
pypi-upload:
Expand All @@ -36,7 +36,7 @@ pypi-web:

# install PyPi version
pypi-install:
python -m pip install randvec
python -m pip install pyrandvec

install-local:
pip install --editable .
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Random vectors with sum one
# Generate random vectors whose components sum up to one

This Python3 module implements different approaches [1] to randomly and uniformly generate d-dimensional vectors whose components sum up to one.

Expand All @@ -10,24 +10,24 @@ This Python3 module implements different approaches [1] to randomly and uniforml
Run the following to install the module:

```bash
pip install randvec
pip install pyrandvec
```

## Usage

```python
from randvec.methods import sample
from pyrandvec import sample

# Generate 10 4-dimensional vectors with the simplex-method
sample(10, 4, method = "simplex")
sample(10, 4, method = 'simplex')

# Generate 10 3-dimensional vectors with the trigonometric methdod with subsequent shuffling
sample(10, 3, method = "trigonometric", shuffle = True)
sample(10, 3, method = 'trigonometric', shuffle = True)
```

# Developing randvec

To install the **randvec** module along with the tools you need to develop and run test, run the following command in your *virtual environment* (virtualenv):
To install the **pyrandvec** module along with the tools you need to develop and run test, run the following command in your *virtual environment* (virtualenv):

```bash
pip install -e .[dev]
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

setuptools.setup(
name = 'pyrandvec',
version = '1.0.2',
version = '1.0.1',
author = 'Jakob Bossek',
author_email = 'j.bossek@gmail.com',
description = 'Generate random vectors whose components sum up to one',
Expand Down

0 comments on commit d5397dd

Please sign in to comment.