Skip to content

Commit

Permalink
README: pip install. Changelog for version update
Browse files Browse the repository at this point in the history
  • Loading branch information
ajjackson committed Aug 11, 2016
1 parent 5f6859a commit d454e4a
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Versioning](http://semver.org/). The changelog format is inspired by

## [Unreleased]

## [0.1.0] - 2016-08-11

### Added

- Initial prototype from random data
Expand All @@ -14,3 +16,5 @@ Versioning](http://semver.org/). The changelog format is inspired by
- Plotting to screen and file
- Limited internal tests
- setuptools-based distribution

[Unreleased]: https://github.com/smtg-ucl/galore/compare/v0.1.0...HEAD
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,25 @@ file and the DOS is read from the DOSCAR.
Galore uses Numpy to apply convolution operations. Matplotlib is
required for plotting.

Galore uses Pip and setuptools for installation. You *probably*
already have this; if not, your GNU/Linux package manager will be able
to oblige with a package named something like `python-setuptools`. On
Max OSX, the Python distributed with [Homebrew](http://brew.sh)
includes setuptools and Pip.

## Installation

At this stage, the recommended installation procedure is, from the
directory containing this README:

pip install --user -e galore

which installs an *editable* (`-e`) version of galore in your
userspace. The executable program `galore` goes to a directory like
`~/.local/bin` and the galore library should be available on your
Pythonpath. These are links to this project folder, which you can
continue to edit and update using Git.

## Development

This code is developed by the Scanlon Materials Theory Group based at
Expand Down

0 comments on commit d454e4a

Please sign in to comment.