oemof-industry


Nameoemof-industry JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryNone
upload_time2024-09-23 09:43:08
maintainerNone
docs_urlNone
authorHendrik Huyskens
requires_python>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# Oemof Industry

Holds the `MultiInputMultiOutputConverter` for modeling industrial components.

## Introduction

The features in this repo were developed for the SEDOS project:

* `MultiInputMultiOutputConverter` (MIMOConverter)
* `MIMO` facade
* `CO2EmissionLimit`

The MIMOConverter is designed to handle multiple inputs and multiple outputs, enabling advanced modeling of
industrial components with the oemof framework.
The `MIMO` facade simplifies the use of the MIMOConverter with [`oemof.tabular`](https://github.com/oemof/oemof-tabular), which loads oemof energy systems from tabular data sources.
Additionally, `CO2EmissionLimit` is provided to add an emission constraint to an energy system based on CO2, CH4 and N2O flows.

## Installation
To install *oemof.industry* follow these steps:

* Clone *oemof.industry*  `git clone https://github.com/sedos-project/oemof.industry.git`
* enter folder `cd oemof.industry`
* create virtual environment using conda: `conda env create -f environment.yml`
* activate environment: `conda activate oemof.industry`
* install oemof.instry package using poetry, via: `poetry install`

## Development

To run the all tests run:

    pytest

## Usage
To use oemof.industry features in a project:

    from oemof_industry.mimo_converter import MultiInputMultiOutputConverter, MIMO
    from oemof_industry. emission_constraint import CO2EmissionLimit

### MIMOConverter


### MIMO facade


### CO2EmissionLimit

## API Reference

## Contributing

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "oemof-industry",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Hendrik Huyskens",
    "author_email": "hendrik.huyskens@rl-institut.de",
    "download_url": "https://files.pythonhosted.org/packages/98/a1/5b83f370d627b2a5dce65786fcf9479f551014e9914a8580fd961c8d0d1e/oemof_industry-0.1.0.tar.gz",
    "platform": null,
    "description": "\n# Oemof Industry\n\nHolds the `MultiInputMultiOutputConverter` for modeling industrial components.\n\n## Introduction\n\nThe features in this repo were developed for the SEDOS project:\n\n* `MultiInputMultiOutputConverter` (MIMOConverter)\n* `MIMO` facade\n* `CO2EmissionLimit`\n\nThe MIMOConverter is designed to handle multiple inputs and multiple outputs, enabling advanced modeling of\nindustrial components with the oemof framework.\nThe `MIMO` facade simplifies the use of the MIMOConverter with [`oemof.tabular`](https://github.com/oemof/oemof-tabular), which loads oemof energy systems from tabular data sources.\nAdditionally, `CO2EmissionLimit` is provided to add an emission constraint to an energy system based on CO2, CH4 and N2O flows.\n\n## Installation\nTo install *oemof.industry* follow these steps:\n\n* Clone *oemof.industry*  `git clone https://github.com/sedos-project/oemof.industry.git`\n* enter folder `cd oemof.industry`\n* create virtual environment using conda: `conda env create -f environment.yml`\n* activate environment: `conda activate oemof.industry`\n* install oemof.instry package using poetry, via: `poetry install`\n\n## Development\n\nTo run the all tests run:\n\n    pytest\n\n## Usage\nTo use oemof.industry features in a project:\n\n    from oemof_industry.mimo_converter import MultiInputMultiOutputConverter, MIMO\n    from oemof_industry. emission_constraint import CO2EmissionLimit\n\n### MIMOConverter\n\n\n### MIMO facade\n\n\n### CO2EmissionLimit\n\n## API Reference\n\n## Contributing\n",
    "bugtrack_url": null,
    "license": null,
    "summary": null,
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "64b7244002917a7395903f147fe5bb9e66f240df736d360198d97f691fed984a",
                "md5": "a9e16e7b5e5d4e781b08546007a615ea",
                "sha256": "f7b64647bec7def212e53c8101f682e699f0c033ffe42c1ac88e9d77737bff0b"
            },
            "downloads": -1,
            "filename": "oemof_industry-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a9e16e7b5e5d4e781b08546007a615ea",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 11990,
            "upload_time": "2024-09-23T09:43:06",
            "upload_time_iso_8601": "2024-09-23T09:43:06.822713Z",
            "url": "https://files.pythonhosted.org/packages/64/b7/244002917a7395903f147fe5bb9e66f240df736d360198d97f691fed984a/oemof_industry-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "98a15b83f370d627b2a5dce65786fcf9479f551014e9914a8580fd961c8d0d1e",
                "md5": "9c380dc2cac43b93975f57a4cabcb945",
                "sha256": "b86173eb626eb6cfff70b9756b511a2101a4daade59510df753dcac2e41c5a5f"
            },
            "downloads": -1,
            "filename": "oemof_industry-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9c380dc2cac43b93975f57a4cabcb945",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 11583,
            "upload_time": "2024-09-23T09:43:08",
            "upload_time_iso_8601": "2024-09-23T09:43:08.512838Z",
            "url": "https://files.pythonhosted.org/packages/98/a1/5b83f370d627b2a5dce65786fcf9479f551014e9914a8580fd961c8d0d1e/oemof_industry-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-23 09:43:08",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "oemof-industry"
}
        
Elapsed time: 0.55715s