semvec/pypi-packages huggingface dataset:
mosaik.SimConfig 0.1.0rc20210813000500
The missing implementation of mosaik's SimConfig dictionary.

# mosaik SimConfig

The missing implementation of mosaik's SimConfig dictionary.

## Status

[![pipeline status](https://gitlab.com/offis.energy/mosaik/mosaik.simconfig/badges/master/pipeline.svg)](https://gitlab.com/offis.energy/mosaik/mosaik.simconfig/pipelines/)
[![coverage report](https://gitlab.com/offis.energy/mosaik/mosaik.simconfig/badges/master/coverage.svg)](https://gitlab.com/offis.energy/mosaik/mosaik.simconfig/-/jobs)
[![libraries status](https://img.shields.io/librariesio/release/pypi/mosaik.SimConfig)](https://libraries.io/pypi/mosaik.SimConfig)
[![license badge](https://img.shields.io/pypi/l/mosaik.SimConfig)](#)
[![PyPI version](https://img.shields.io/pypi/v/mosaik.SimConfig)](https://pypi.org/project/mosaik.SimConfig/#history)
[![Python Versions](https://img.shields.io/pypi/pyversions/mosaik.SimConfig)](https://pypi.org/project/mosaik.SimConfig)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2978/badge)](https://bestpractices.coreinfrastructure.org/projects/2978)

## Ensuring PIP

    python -m ensurepip

## Setting up the Virtual Environment

    python -m venv venv

## Installing Requirements

     python -m pip install --upgrade -r requirements.d/venv.txt

## Running the Tests

Under Linux:

    venv/bin/python -m tox

Under Windows:

    venv\Scripts\python.exe -m tox

## Updating the Virtual Environment Requirements

Under Linux:

    venv/bin/python -m pip_review --auto

Under Windows:

    venv\Scripts\python.exe -m pip_review --auto

## Freezing the Virtual Environment Requirements

Under Linux

     venv/bin/python -m pip freeze --all --exclude-editable > requirements.d/venv.txt
     # And remove line beginning with package name

Under Windows

     venv\Scripts\python.exe -m pip freeze --all --exclude-editable > requirements.d/venv.txt
    # And remove line beginning with package name

## Updating the Test Environment Requirements

Under Linux:

    .tox/py36/bin/python -m pip_review --auto

Under Windows:

    venv\Scripts\python.exe -m pip_review --auto

## Freezing the Test Environment Requirements

Under Linux

    .tox/py36/bin/python -m pip freeze --all --exclude-editable > requirements.d/base.txt
    # And remove line beginning with package name

Under Windows

    .tox\py36\Scripts\python -m pip freeze --all --exclude-editable > requirements.d/base.txt
    # And remove line beginning with package name

## Using the Package

    from mosaik_simconfig.simconfig.sim_config import SimConfig
    from tests.mock.simulator import MockSimulator

    sim_config = SimConfig()
    sim_config.add_in_process(simulator=MockSimulator)

    mosaik.scenario.World(sim_config=sim_config).run(until=1)

For more usage examples, see the tests.


Changelog
=========

0.1.0 - 2019-03-25
------------------

- [NEW] Initial release on GitLab.com


Authors
=======

Bengt Lüers
wsp-tools 1.4.1
Utilities for TEM data analysis and simulation.
Requires Python: >=3.6

# wsp_tools
Utilities for TEM data analysis and simulation.

Features:

* Single Image TIE
* Lorentz TEM simulations
* spatial modes
* a `matplotlib.pyplot` wrapper
* an implementation of the CIELAB colorspace
* a `scipy.constants` wrapper that allows arbitrary units (i.e., using nanometers instead of meters)

## Installation

### Pip
As of version 1.3.1, `wsp_tools` is available on PyPi, and can be installed with `pip`:

```Bash
python -m pip install wsp-tools
```

### GitHub
`wsp_tools` can also be installed directly from GitHub via
```Bash
pip install -e git+https://github.com/McMorranLab/wsp_tools#egg=wsp-tools
```

Installing in editable mode `-e` ensures that `pip freeze` records the install url, not just the version.

You can specify the commit or tag to install, via

```Bash
pip install -e git+https://github.com/McMorranLab/wsp_tools@{commit id or tag number}#egg=wsp_tools
```

## Documentation

As of version 1.3.1, documentation is available at [https://mcmorranlab.github.io/wsp_tools/](https://mcmorranlab.github.io/wsp_tools/).

As of version 1.0.94, wsp_tools includes a helper function `docs(outdir=".")`, which uses ```pdoc3``` to auto-generate html documentation and save it to an outdir of your choice, thus avoiding the need to clone this repository just to see the documentation. For example:

```Python
import wsp_tools
wsp_tools.docs("~/Desktop") # generates docs in the folder ~/Desktop/wsp_tools
```

## Tests

Tests are split into two subdirectories:

1. `tests`
	These are typical unit tests, that assert that functions return the right shape, beam parameters return the right values, etc. Run with `pytest`.
2. `devtests`
	These are tests of the actual functionality, that require a trained eye to evaluate. For example, a function `test_bessel()` will generate a bessel beam using `wsp_tools.bessel()`, but rather than asserting a unit test, will just plot the bessel beam so the developer can manually assert whether it looks correct. Run as normal `.py` scripts.

The rationale for `devtests` is that this package is math-heavy, so it's highly possible for the code to run fine, but be wrong. The easiest way to test for this is to check base cases where the developer knows what to look for.