Metadata-Version: 2.1
Name: vencopy
Version: 0.1.5
Summary: Vehicle Energy Consumption in Python: A tool to simulate load flexibility of electric vehicle fleets.
Home-page: https://gitlab.com/dlr-ve/vencopy
Author: Niklas Wulff
Author-email: niklas.wulff@dlr.de
License: BSD 3-clause
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas (<=1.2.5,>=1.1.1)
Requires-Dist: ruamel.yaml
Requires-Dist: seaborn
Requires-Dist: openpyxl
Requires-Dist: jupyterlab
Requires-Dist: Click
Requires-Dist: pyyaml

# Welcome to VencoPy!


![PyPI](https://img.shields.io/pypi/v/vencopy)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/vencopy)
![Documentation Status](https://readthedocs.org/projects/vencopy/badge/?version=latest)
![PyPI - License](https://img.shields.io/pypi/l/vencopy)
[![Gitter](https://badges.gitter.im/vencopy/community.svg)](https://gitter.im/vencopy/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

- Authors: Niklas Wulff, Fabia Miorelli
- Contact: niklas.wulff@dlr.de


Contents
========

 * [Description](#description)
 * [Installation](#installation)
 * [Codestyle](#codestyle)
 * [Documentation](#documentation)
 * [Useful Links](#useful-links)
 * [Want to contribute?](#want-to-contribute)

Description
---
A data processing tool offering hourly demand and flexibility profiles for future electric vehicle fleets in an aggregated manner.


Installation
---
Depending on if you want to use VencoPy or if you want to contribute, there are 
two different installation procedures described in VencoPy's documentation:

[I want to apply the tool](https://vencopy.readthedocs.io/en/latest/gettingstarted/installation.html#installation-for-users)

[I want to contribute to the codebase, the documentation or the tutorials](https://vencopy.readthedocs.io/en/latest/gettingstarted/installation.html#installation-for-developers)

In order to start using VencoPy, check out our [tutorials](https://vencopy.readthedocs.io/en/latest/gettingstarted/start.html#getting-started-and-tutorials). For this you won't need any additional data.

To run VencoPy in full mode, you will need the data set Mobilität in Deutschland (German for mobility in Germany). You
can request it here from the clearingboard transport: https://daten.clearingstelle-verkehr.de/order-form.html Currently, 
VencoPy is so far only tested with the B2 data set of MiD 2008 and MiD 2017.

Enjoy the tool, we're happy to receive feedback!


Codestyle
---
We use PEP-8, with the exception of lowerCamelCase for method and variable names as well as UpperCamelCase for classes.

Documentation
---
The documentation can be found here: https://vencopy.readthedocs.io/en/latest/index.html
To build the documentation from a conda bash with an activated environment type:

```python
sphinx-build -b html ./docs/ ./build/
``` 

Useful Links
---

* Documentation: https://vencopy.readthedocs.io/en/latest/index.html#
* Source code: https://gitlab.com/dlr-ve/vencopy
* PyPI release: https://pypi.org/project/vencopy
* Licence: https://opensource.org/licenses/BSD-3-Clause
  

Want to contribute?
---
Great, welcome on the VencoPy team! Please read our contribute section in the documentation and reach out to Niklas 
(niklas.wulff@dlr.de). If experience difficulties on set up or have other technical questions, join our 
[gitter community](https://gitter.im/vencopy/community)  


