rlenv


Namerlenv JSON
Version 1.1.dev2 PyPI version JSON
download
home_page
SummaryAccenta.AI Gym Environement
upload_time2023-03-16 16:48:02
maintainerJérémie DECOCK
docs_urlNone
authorJérémie DECOCK
requires_python
license
keywords rlenv
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =======================
Accenta Gym Environment
=======================

Copyright (c) 2019-2022 Accenta (www.accenta.ai)

* Web site: https://gitlab.com/ens-data-challenge/accenta-gym-environment
* Online documentation: https://ens-data-challenge.gitlab.io/accenta-gym-environment
* Examples: https://ens-data-challenge.gitlab.io/accenta-gym-environment/gallery/

* Source code: https://gitlab.com/ens-data-challenge/accenta-gym-environment
* Issue tracker: https://gitlab.com/ens-data-challenge/accenta-gym-environment/issues


Description
===========

Accenta Gym Environment

Note:

    This project is still in beta stage, so the API is not finalized yet.


Dependencies
============

C.f. requirements.txt

.. _install:

Installation
============

Posix (Linux, MacOSX, WSL, ...)
-------------------------------

From the EnergyPlus Python source code::

    conda deactivate         # Only if you use Anaconda...
    python3 -m venv env
    source env/bin/activate
    python3 -m pip install --upgrade pip
    python3 -m pip install -r requirements.txt
    python3 setup.py develop


Windows
-------

From the EnergyPlus Python source code::

    conda deactivate         # Only if you use Anaconda...
    python3 -m venv env
    env\Scripts\activate.bat
    python3 -m pip install --upgrade pip
    python3 -m pip install -r requirements.txt
    python3 setup.py develop


Build and run the Accenta Gym Environment Docker image
======================================================

Build the docker image
----------------------

From the EnergyPlus Python source code::

    docker build -t registry.gitlab.com/ens-data-challenge/accenta-gym-environment .

Run unit tests from the docker container
----------------------------------------

From the EnergyPlus Python source code::

    docker run registry.gitlab.com/ens-data-challenge/accenta-gym-environment pytest

Run an example from the docker container
----------------------------------------

From the EnergyPlus Python source code::

    docker run registry.gitlab.com/ens-data-challenge/accenta-gym-environment python3 /rlenv/examples/plot_wall_env.py

Push the docker image on the container registry
-----------------------------------------------

From the EnergyPlus Python source code::

    docker push registry.gitlab.com/ens-data-challenge/accenta-gym-environment


Documentation
=============

* Online documentation: https://ens-data-challenge.gitlab.io/accenta-gym-environment
* API documentation: https://ens-data-challenge.gitlab.io/accenta-gym-environment/api.html


Example usage
=============

C.f. https://ens-data-challenge.gitlab.io/accenta-gym-environment/gallery/


Bug reports
===========

To search for bugs or report them, please use the Accenta's Gym Environments Bug Tracker at:

    https://gitlab.com/accenta_group/ai-gym/issues

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "rlenv",
    "maintainer": "J\u00e9r\u00e9mie DECOCK",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "jeremie.decock@accenta.ai",
    "keywords": "rlenv",
    "author": "J\u00e9r\u00e9mie DECOCK",
    "author_email": "jeremie.decock@accenta.ai",
    "download_url": "https://files.pythonhosted.org/packages/05/53/6741d0800347ae29b540cd4430b909634e77eeb27fcc7f9fb5b19def76dd/rlenv-1.1.dev2.tar.gz",
    "platform": null,
    "description": "=======================\nAccenta Gym Environment\n=======================\n\nCopyright (c) 2019-2022 Accenta (www.accenta.ai)\n\n* Web site: https://gitlab.com/ens-data-challenge/accenta-gym-environment\n* Online documentation: https://ens-data-challenge.gitlab.io/accenta-gym-environment\n* Examples: https://ens-data-challenge.gitlab.io/accenta-gym-environment/gallery/\n\n* Source code: https://gitlab.com/ens-data-challenge/accenta-gym-environment\n* Issue tracker: https://gitlab.com/ens-data-challenge/accenta-gym-environment/issues\n\n\nDescription\n===========\n\nAccenta Gym Environment\n\nNote:\n\n    This project is still in beta stage, so the API is not finalized yet.\n\n\nDependencies\n============\n\nC.f. requirements.txt\n\n.. _install:\n\nInstallation\n============\n\nPosix (Linux, MacOSX, WSL, ...)\n-------------------------------\n\nFrom the EnergyPlus Python source code::\n\n    conda deactivate         # Only if you use Anaconda...\n    python3 -m venv env\n    source env/bin/activate\n    python3 -m pip install --upgrade pip\n    python3 -m pip install -r requirements.txt\n    python3 setup.py develop\n\n\nWindows\n-------\n\nFrom the EnergyPlus Python source code::\n\n    conda deactivate         # Only if you use Anaconda...\n    python3 -m venv env\n    env\\Scripts\\activate.bat\n    python3 -m pip install --upgrade pip\n    python3 -m pip install -r requirements.txt\n    python3 setup.py develop\n\n\nBuild and run the Accenta Gym Environment Docker image\n======================================================\n\nBuild the docker image\n----------------------\n\nFrom the EnergyPlus Python source code::\n\n    docker build -t registry.gitlab.com/ens-data-challenge/accenta-gym-environment .\n\nRun unit tests from the docker container\n----------------------------------------\n\nFrom the EnergyPlus Python source code::\n\n    docker run registry.gitlab.com/ens-data-challenge/accenta-gym-environment pytest\n\nRun an example from the docker container\n----------------------------------------\n\nFrom the EnergyPlus Python source code::\n\n    docker run registry.gitlab.com/ens-data-challenge/accenta-gym-environment python3 /rlenv/examples/plot_wall_env.py\n\nPush the docker image on the container registry\n-----------------------------------------------\n\nFrom the EnergyPlus Python source code::\n\n    docker push registry.gitlab.com/ens-data-challenge/accenta-gym-environment\n\n\nDocumentation\n=============\n\n* Online documentation: https://ens-data-challenge.gitlab.io/accenta-gym-environment\n* API documentation: https://ens-data-challenge.gitlab.io/accenta-gym-environment/api.html\n\n\nExample usage\n=============\n\nC.f. https://ens-data-challenge.gitlab.io/accenta-gym-environment/gallery/\n\n\nBug reports\n===========\n\nTo search for bugs or report them, please use the Accenta's Gym Environments Bug Tracker at:\n\n    https://gitlab.com/accenta_group/ai-gym/issues\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Accenta.AI Gym Environement",
    "version": "1.1.dev2",
    "split_keywords": [
        "rlenv"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "73d37004093acfeacc4487eaf4c65d307831cd5e8e1a8b202619acff5341c3b4",
                "md5": "e6062ac0e5e3d10bc6aed2918464e8b9",
                "sha256": "792b44decd8249a784db2ec4adadd56b4002e98a67370b2574d390bf4b7868df"
            },
            "downloads": -1,
            "filename": "rlenv-1.1.dev2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e6062ac0e5e3d10bc6aed2918464e8b9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 16313,
            "upload_time": "2023-03-16T16:47:59",
            "upload_time_iso_8601": "2023-03-16T16:47:59.428292Z",
            "url": "https://files.pythonhosted.org/packages/73/d3/7004093acfeacc4487eaf4c65d307831cd5e8e1a8b202619acff5341c3b4/rlenv-1.1.dev2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "05536741d0800347ae29b540cd4430b909634e77eeb27fcc7f9fb5b19def76dd",
                "md5": "96c75d3bb965a02a204f9fb921f30757",
                "sha256": "e26c952c840c7a41d9f0d1754f1266b98aae88b1231bae1bb3c959cf33c1505f"
            },
            "downloads": -1,
            "filename": "rlenv-1.1.dev2.tar.gz",
            "has_sig": false,
            "md5_digest": "96c75d3bb965a02a204f9fb921f30757",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 1225036,
            "upload_time": "2023-03-16T16:48:02",
            "upload_time_iso_8601": "2023-03-16T16:48:02.851463Z",
            "url": "https://files.pythonhosted.org/packages/05/53/6741d0800347ae29b540cd4430b909634e77eeb27fcc7f9fb5b19def76dd/rlenv-1.1.dev2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-16 16:48:02",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "rlenv"
}
        
Elapsed time: 0.11884s