https://github.com/helveg/pip-nest

https://github.com/helveg/pip-nest

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/helveg/pip-nest
• Owner: Helveg
• License: mit
• Created: 2020-05-26T10:43:29.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-15T17:41:33.000Z (6 months ago)
• Last Synced: 2024-10-10T09:31:07.135Z (3 months ago)
• Language: Python
• Size: 25.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pipnest

pipnest packages your NEST extension

modules into pip installable packages. This is a benefit when you're

distributing a Python model for the NEST simulator and have a dependency

on an extension module. Instead of having to provide installation

instructions to your end-users you can have pip download and build the

extension module into the target machine's nest installation.

# Usage

## Project structure

  - Prepare a folder with 1 subfolder that contains a NEST extension

    modules.

  - The source code of the extension module can not be in the root

    repository.

  - The name of your module should be the name of your folders plus

    "module".

Your project structure should look like this:

    - my_module

      - my_module

        - my_file1.cpp

        - my_file2.cpp

        - ...

In this example your NEST module should be called the `my_modulemodule`.

## Initialize project

Run the `pipnest init` command from the root folder and fill in the

requested metadata:

    cd my_module

    pipnest init .

This should create a setup.py and README.md, be sure to edit the latter.

Check that your module is present under the `packages` keyword argument

in `setup.py`.

## Package

Create the source distribution:

    python setup.py sdist

### Test your package locally

  - Remove any already installed versions from the

    `$NEST_INSTALL_DIR/lib/nest` folder

  - Run `pip install dist/*`. (If an MPI error occurs, restart your

    terminal and try again)

## Upload to PyPI

Use twine to upload your package:

    twine upload dist/* --skip-existing