https://github.com/derthorsten/nifty_infusion_python

https://github.com/derthorsten/nifty_infusion_python

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/derthorsten/nifty_infusion_python
• Owner: DerThorsten
• License: mit
• Created: 2017-10-12T09:36:03.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-10-12T18:04:09.000Z (over 8 years ago)
• Last Synced: 2025-04-09T00:05:37.993Z (about 1 year ago)
• Language: CMake
• Size: 25.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
nifty_infusion_python

==============

nifty-infusions python bindings

Installation

------------

**On Unix (Linux, OS X)**

 - clone this repository

 - `pip install ./nifty_infusion_python`

**On Windows (Requires Visual Studio 2015)**

 - For Python 3.5:

     - clone this repository

     - `pip install ./nifty_infusion_python`

 - 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 ./nifty_infusion_python`

   Note that this requires the user building `nifty_infusion_python` 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:

 - `nifty_infusion_python/docs`

 - `make html`

Running the tests

-----------------

Running the tests requires `pytest`.

```bash

py.test .

```