Skip to content
Permalink
Browse files

Pull in a few updates from the fork

- Badges
- Readme sections + mention the license
- Standard gitignores (including MANIFEST)
- Remove a couple unused targets in the Makefile
  • Loading branch information...
paulmelnikow committed Sep 19, 2019
1 parent 7af8601 commit 59366ef7143db771639ec1ae13189cbffc831f34
Showing with 139 additions and 23 deletions.
  1. +99 −12 .gitignore
  2. +2 −10 Makefile
  3. +38 −1 README.md
@@ -1,26 +1,67 @@

# Created by https://www.gitignore.io/api/osx,python

### OSX ###
# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon

# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

### Python ###
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
env/
bin/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
@@ -30,26 +71,72 @@ pip-delete-this-directory.txt
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/

# Translations
*.mo

# Mr Developer
.mr.developer.cfg
.project
.pydevproject

# Rope
.ropeproject
*.pot

# Django stuff:
*.log
*.pot
local_settings.py
db.sqlite3

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

.DS_Store
# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/

### Python Patch ###
.venv/


# End of https://www.gitignore.io/api/osx,python
@@ -1,18 +1,11 @@
all:

upload:
rm -r dist
python setup.py sdist
twine upload dist/*

#sdist:
# python setup.py sdist && rsync -avz dist/chumpy-0.5.tar.gz files:~/chumpy/latest.tgz && python ./api_compatibility.py && rsync -avz ./api_compatibility.html files:~/chumpy/

clean:

tidy:

test: clean qtest
qtest: all
test:
# For some reason the import changes for Python 3 caused the Python 2 test
# loader to give up without loading any tests. So we discover them ourselves.
# python -m unittest
@@ -23,4 +16,3 @@ qcov: all
env LD_PRELOAD=$(PRELOADED) coverage run --source=. -m unittest discover -s .
coverage html
coverage report -m

@@ -1,6 +1,35 @@
chumpy
======

[![version](https://img.shields.io/pypi/v/chumpy?style=flat-square)][pypi]
[![license](https://img.shields.io/pypi/l/chumpy?style=flat-square)][pypi]
[![python versions](https://img.shields.io/pypi/pyversions/chumpy?style=flat-square)][pypi]
[![build status](https://img.shields.io/circleci/project/github/mattloper/chumpy/master?style=flat-square)][circle]

Autodifferentiation tool for Python.

[circle]: https://circleci.com/gh/mattloper/chumpy
[pypi]: https://pypi.org/project/chumpy/


Installation
------------

Install the fork:

```sh
pip install chumpy
```

Import it:

```py
import chumpy as ch
```

Overview
--------

Chumpy is a Python-based framework designed to handle the **auto-differentiation** problem,
which is to evaluate an expression and its derivatives with respect to its inputs, by use of the chain rule.

@@ -13,11 +42,19 @@ Specifically, it provides:
- Easy access to derivatives via auto differentiation
- Easy local optimization methods (12 of them: most of which use the derivatives)


Usage
-----

Chumpy comes with its own demos, which can be seen by typing the following:

```python
import chumpy
chumpy.demo() # prints out a list of possible demos
```

Licensing is specified in the attached LICENSE.txt.

License
-------

This project is licensed under the MIT License.

0 comments on commit 59366ef

Please sign in to comment.
You can’t perform that action at this time.