Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Repo name change #147

Merged
merged 3 commits into from
Jan 6, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ language: python
python:
- "3.7"
install:
- pip install 'numpy>=1.19'
- pip install -r requirements.txt
- pip install -r requirements-dev.txt
- pip install -r requirements-optional.txt
Expand Down
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ values, optimizing hyperparameter values, and making predictions on unseen data.
experimental design, dimension reduction, and calibration tools to enable modellers to understand complex
computer simulations.

[![Build Status](https://travis-ci.com/alan-turing-institute/mogp_emulator.svg?branch=master)](https://travis-ci.com/alan-turing-institute/mogp_emulator)
[![codecov](https://codecov.io/gh/alan-turing-institute/mogp_emulator/branch/master/graph/badge.svg)](https://codecov.io/gh/alan-turing-institute/mogp_emulator)
[![Build Status](https://travis-ci.com/alan-turing-institute/mogp-emulator.svg?branch=master)](https://travis-ci.com/alan-turing-institute/mogp-emulator)
[![codecov](https://codecov.io/gh/alan-turing-institute/mogp-emulator/branch/master/graph/badge.svg)](https://codecov.io/gh/alan-turing-institute/mogp-emulator)
[![Documentation Status](https://readthedocs.org/projects/mogp-emulator/badge/?version=latest)](https://mogp-emulator.readthedocs.io/en/latest/?badge=latest)

## Installation
Expand All @@ -16,15 +16,9 @@ computer simulations.
installed via `pip`:

```bash
pip install mogp_emulator
pip install mogp-emulator
```

(NOTE: the project is not yet on PyPI, but we expect that the current version of the `devel` branch will
be the first one available to be installed that way so are accounting for this in the rewrite of this
README. Until that is completed, please see the [docs/installation.rst](docs/intro/installation.rst)
page for details on how to install the software manually. Thank you for your patience as we are hard
at work on improvements to the software!)

Optionally, you may want to install some additional optional packages. `matplotlib` is useful for
visualising some of the results of the benchmarks, and `patsy` is highly recommended for users that
wish to parse R-style string formulas for specifying mean functions. These can be found in the
Expand Down
24 changes: 13 additions & 11 deletions docs/intro/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ Installation
In most cases, the easiest way to install ``mogp_emulator`` is via ``pip``, which should install the
library and all of its dependencies: ::

pip install mogp_emulator
pip install mogp-emulator

(NOTE: the project is not yet on PyPI, but we expect that the current version of the ``devel`` branch will
be the first one available to be installed that way so are accounting for this in the rewrite of this
documentation. Until that is completed, please follow the instructions below to install the software
manually. Thank you for your patience as we are hard at work on improvements to the software!)
You can also use ``pip`` to install directly from the github repository using ::

pip install git+https://github.com/alan-turing-institute/mogp-emulator

This will accomplish the same thing as the manual installation instructions
below.

Manual Installation
-------------------

Expand All @@ -28,7 +30,7 @@ below.

If you prefer to check out the Github repository, you can download the code using: ::

git clone https://github.com/alan-turing-institute/mogp_emulator/
git clone https://github.com/alan-turing-institute/mogp-emulator/

This will clone the entire git history of the software and check out the ``master`` branch by default.
The ``master`` branch is the most stable version of the code, but will not have all features as the
Expand Down Expand Up @@ -61,15 +63,15 @@ Installation

Then to install the main code, run the following command: ::

python setup.py install
python setup.py install

This will install the main code in the system Python installation. You may need adminstrative priveleges
to install the software itself, depending on your system configuration. However, any updates to the code
cloned through the github repository (particularly if you are using the devel branch, which is under more
active development) will not be reflected in the system installation using this method. If you would like
to always have the most active development version, install using: ::

python setup.py develop
python setup.py develop

This will insert symlinks to the repository files into the system Python installation so that files
are updated whenever there are changes to the code files.
Expand All @@ -86,12 +88,12 @@ change to the ``docs`` directory. There is a Makefile in the `docs` directory to
documentation for you. To build the HTML version, enter the
following into the shell from the ``docs`` directory: ::

make html
make html

This will build the HTML version of the documentation. A standalone PDF version can be built, which
requires a standard LaTeX installation, via: ::

make latexpdf
make latexpdf

In both cases, the documentation files can be found in the corresponding directories in the ``docs/_build``
directory. Note that if these directories are not found on your system, you may need to create them in
Expand All @@ -113,4 +115,4 @@ the code to determine test coverage.
The tests can be run from the base ``mogp_emulator`` directory or the ``mogp_emulator/tests`` directory
by entering ``pytest``, which will run all tests and print out the results to the console. In the
``mogp_emulator/tests`` directory, there is also a ``Makefile`` that will run the tests for you.
You can simply enter ``make tests`` into the shell.
You can simply enter ``make tests`` into the shell.
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
MAJOR = 0
MINOR = 4
MICRO = 0
PRERELEASE = 2
PRERELEASE = 3
ISRELEASED = False
version = "{}.{}.{}".format(MAJOR, MINOR, MICRO)

Expand Down Expand Up @@ -36,9 +36,9 @@ def write_version_file(version):
long_description_content_type="text/markdown",
url='https://mogp-emulator.readthedocs.io/',
project_urls={
"Bug Tracker": "https://github.com/alan-turing-institute/mogp_emulator/issues",
"Bug Tracker": "https://github.com/alan-turing-institute/mogp-emulator/issues",
"Documentation": "https://mogp-emulator.readthedocs.io/",
"Source Code": "https://github.com/alan-turing-institute/mogp_emulator/",
"Source Code": "https://github.com/alan-turing-institute/mogp-emulator/",
},
author='Alan Turing Institute Research Engineering Group',
author_email='edaub@turing.ac.uk',
Expand Down