https://github.com/derthorsten/colored_hist
colored_hist
https://github.com/derthorsten/colored_hist
Last synced: about 1 year ago
JSON representation
colored_hist
- Host: GitHub
- URL: https://github.com/derthorsten/colored_hist
- Owner: DerThorsten
- Created: 2019-09-17T12:13:22.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-24T13:15:13.000Z (almost 7 years ago)
- Last Synced: 2025-02-14T18:49:09.241Z (over 1 year ago)
- Language: Jupyter Notebook
- Size: 14.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
colored_hist
==============
colored hist
Installation
------------
**On Unix (Linux, OS X)**
- clone this repository
- `pip install ./colored_hist`
**On Windows (Requires Visual Studio 2015)**
- For Python 3.5:
- clone this repository
- `pip install ./colored_hist`
- For earlier versions of Python, including Python 2.7:
xtensor requires a C++14 compliant compiler (i.e. Visual Studio 2015 on
Windows). Running a regular `pip install` command will detect the version
of the compiler used to build Python and attempt to build the extension
with it. We must force the use of Visual Studio 2015.
- clone this repository
- `"%VS140COMNTOOLS%\..\..\VC\vcvarsall.bat" x64`
- `set DISTUTILS_USE_SDK=1`
- `set MSSdk=1`
- `pip install ./colored_hist`
Note that this requires the user building `colored_hist` to have registry edition
rights on the machine, to be able to run the `vcvarsall.bat` script.
Windows runtime requirements
----------------------------
On Windows, the Visual C++ 2015 redistributable packages are a runtime
requirement for this project. It can be found [here](https://www.microsoft.com/en-us/download/details.aspx?id=48145).
If you use the Anaconda python distribution, you may require the Visual Studio
runtime as a platform-dependent runtime requirement for you package:
```yaml
requirements:
build:
- python
- setuptools
- pybind11
run:
- python
- vs2015_runtime # [win]
```
Building the documentation
--------------------------
Documentation for the example project is generated using Sphinx. Sphinx has the
ability to automatically inspect the signatures and documentation strings in
the extension module to generate beautiful documentation in a variety formats.
The following command generates HTML-based reference documentation; for other
formats please refer to the Sphinx manual:
- `colored_hist/docs`
- `make html`
Running the tests
-----------------
Running the tests requires `pytest`.
```bash
py.test .
```