EMM

https://emm.readthedocs.io/en/latest/
Admin
EMM is a Python package for endocytic membrane modeling that infers optimal parameters of membrane...
Tokens:984
Snippets:24
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install project dependencies

Source: https://emm.readthedocs.io/en/latest/contributing.html

Install the project in editable mode within a virtual environment.

```bash
$ cd emm/
$ pip install -e .[dev]
```

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

### Install Requirements

Source: https://emm.readthedocs.io/en/latest/index.html

Install the package dependencies using pip.

```bash
$ pip install -e .[all]
```

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

### Install EMM from Source

Source: https://emm.readthedocs.io/en/latest/installation.html

Install EMM after downloading or cloning the source code. This command should be run from the root of the source directory.

```bash
python setup.py install
```

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

### Install EMM Stable Release

Source: https://emm.readthedocs.io/en/latest/installation.html

Use this command to install the latest stable version of EMM via pip. Ensure pip is installed.

```bash
pip install emm
```

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

### Clone EMM Repository

Source: https://emm.readthedocs.io/en/latest/installation.html

Clone the EMM public repository from GitHub to get the source code. This is an alternative to installing the stable release.

```bash
git clone git://github.com/ritvikvasan/emm
```

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

### Install EMM Environment

Source: https://emm.readthedocs.io/en/latest/index.html

Commands to create and activate a conda environment for EMM.

```bash
$ conda create –name emm python=3.7
```

```bash
$ conda activate emm
```

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

### Run Simulation

Source: https://emm.readthedocs.io/en/latest/index.html

Navigate to the notebooks directory and launch the simulation notebook.

```bash
$ cd notebooks
$ jupyter notebook MembraneNotebook
```

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

### Run build and tests

Source: https://emm.readthedocs.io/en/latest/contributing.html

Execute linting and tests to verify changes.

```bash
$ make build
```

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

### Clone the repository

Source: https://emm.readthedocs.io/en/latest/contributing.html

Initial step to obtain a local copy of the project repository.

```bash
$ git clone --recurse-submodules git@github.com:{your_name_here}/emm.git
```

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

### Create a development branch

Source: https://emm.readthedocs.io/en/latest/contributing.html

Initialize a new branch for local feature or bugfix development.

```bash
$ git checkout -b {your_development_type}/short-description
```

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

### Deploy project updates

Source: https://emm.readthedocs.io/en/latest/contributing.html

Commands for maintainers to increment the version and push tags for deployment.

```bash
$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags
```

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

### Commit and push changes

Source: https://emm.readthedocs.io/en/latest/contributing.html

Stage, commit, and push local changes to the remote repository.

```bash
$ git add .
$ git commit -m "Resolves gh-###. Your detailed description of your changes."
$ git push origin {your_development_type}/short-description
```

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

### Download EMM Source Tarball

Source: https://emm.readthedocs.io/en/latest/installation.html

Download the EMM source code as a tarball from the GitHub master branch. This is an alternative to cloning the repository.

```bash
curl  -OL https://github.com/ritvikvasan/emm/tarball/master
```
Tokens:
Raw