Metadata-Version: 2.1
Name: ndn4sid
Version: 0.0.12
Summary: A package to perform n4sid on nD systems
Home-page: https://example.com
Author: Bob Vergauwen
Author-email: bob.vergauwen@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: numpy (~=1.19)
Requires-Dist: sympy (~=1.6.2)
Provides-Extra: dev
Requires-Dist: pytest (~=3.7) ; extra == 'dev'
Requires-Dist: check-manifest (~=0.46) ; extra == 'dev'
Requires-Dist: twine (~=3.4.2) ; extra == 'dev'
Requires-Dist: tox (~=3.24) ; extra == 'dev'

# ndn4sid

A first implementation of ndn4sid.



## Installation

Run the following command to install:

```
pip install ndn4sid
```

## Usage
The source folder contains a directory with examples.


## Testing
In order to run the tests, install the package with the [dev] option.
This is done via the command
```
pip install "nd4sid[dev]"
```
To test the current version of the code on your machine, you can run
```
pytest
```
To do a full test of the code use ```tox```
```
tox
```

## Steps to update the code 
Update the manifest file to include all files in de final project 
```
check-manifest --update
```
Compile the latest version of the code
```
python setup.py bdist_wheel sdist
```
Upload the code to Pypi, make sure to update the build number. 
```
twine upload --skip-existing dist/*
```


