Skip to content

Commit

Permalink
Add README, Contributing Guidelines and conda environment (#3)
Browse files Browse the repository at this point in the history
* Add README, Contributing Guidelines and conda environment

* pip correction
  • Loading branch information
prasunanand committed Feb 17, 2020
1 parent 119c969 commit 25db161
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .conda/environment.yml
@@ -0,0 +1,24 @@
name: uarray
channels:
- pytorch
- xnd/label/dev
- defaults
- conda-forge
dependencies:
- python=3.7
- pip
- sphinx
- sphinx_rtd_theme
- pytest
- pytest-cov
- mypy
- pytorch-cpu
- scipy
- gumath
- dask
- sparse
- doc8
- black
- pip:
- pytest-mypy
- pytest-black
37 changes: 37 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,37 @@
# Contributing

Contributions to `udiff` are welcome and appreciated. Contributions can take the form of bug reports, documentation, code, and more.

## Getting the code

Make a fork of the main [udiff repository](https://github.com/Quansight-Labs/udiff) and clone the fork:

```
git clone https://github.com/<your-github-username>/udiff
```

## Install

Note that udiff supports Python versions >= 3.5. If you're running `conda` and would prefer to have dependencies
pulled from there, use

```
conda env create -f .conda/environment.yml
conda activate uarray
```

This will create an environment named `uarray` which you can use for development.

`unumpy` and all development dependencies can be installed via:

```
pip install -e .
```

## Testing

Tests can be run from the main uarray directory as follows:

```
pytest
```
7 changes: 7 additions & 0 deletions README.md
@@ -0,0 +1,7 @@
# udiff
Automatic differentiation with uarray/unumpy.


## Contributing

See [`CONTRIBUTING.md`](CONTRIBUTING.md) for more information on how to contribute to `udiff`.

0 comments on commit 25db161

Please sign in to comment.