| Name | pCrunch JSON |
| Version |
1.0.5
JSON |
| download |
| home_page | |
| Summary | IO and Post Processing Interface for OpenFAST Results. |
| upload_time | 2023-08-29 11:15:36 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | Apache-2.0 |
| keywords |
wind
turbine
fatigue
ultimate
aeroelastic
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
pCrunch
=======
IO and Post Processing Interface for OpenFAST Results.
:Authors: Jake Nunemaker, Nikhar Abbas
Installation
------------
pCrunch is installable through pip via ``pip install pCrunch`` or conda, ``conda install pCrunch``.
Development Setup
-----------------
To set up pCrunch for development, follow these steps:
1. Download the latest version of `Miniconda <https://docs.conda.io/en/latest/miniconda.html>`_
for the appropriate OS. Follow the remaining `steps <https://conda.io/projects/conda/en/latest/user-guide/install/index.html#regular-installation>`_
for the appropriate OS version.
2. From the terminal, install pip by running: ``conda install -c anaconda pip``
3. Next, create a new environment for the project with the following.
.. code-block:: console
conda create -n pcrunch-dev
To activate/deactivate the environment, use the following commands.
.. code-block:: console
conda activate pcrunch-dev
conda deactivate pcrunch-dev
4. Clone the repository:
``git clone https://github.com/NREL/pCrunch.git``
5. Navigate to the top level of the repository
(``<path-to-pCrunch>/pCrunch/``) and install pCrunch as an editable package
with following commands.
.. code-block:: console
pip install -e '.[dev]'
6. (Preferred) Install the pre-commit hooks to autoformat code, ensuring
consistent code style across the repository.
.. code-block:: console
pre-commit install
Examples
--------
For an up to date example of the core functionalities, see `example.ipynb`. More
examples coming soon.
Raw data
{
"_id": null,
"home_page": "",
"name": "pCrunch",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Jake Nunemaker <jake.nunemaker@nrel.gov>, Nikhar Abbas <nikhar.abbas@nrel.gov>",
"keywords": "wind,turbine,fatigue,ultimate,aeroelastic",
"author": "",
"author_email": "NREL WISDEM Team <systems.engineering@nrel.gov>",
"download_url": "https://files.pythonhosted.org/packages/d8/d9/2974717cde0cf76ae63ce126ec0893157c6b604471445f43b50958fd1ab6/pCrunch-1.0.5.tar.gz",
"platform": null,
"description": "pCrunch\n=======\n\nIO and Post Processing Interface for OpenFAST Results.\n\n:Authors: Jake Nunemaker, Nikhar Abbas\n\nInstallation\n------------\n\npCrunch is installable through pip via ``pip install pCrunch`` or conda, ``conda install pCrunch``.\n\nDevelopment Setup\n-----------------\n\nTo set up pCrunch for development, follow these steps:\n\n1. Download the latest version of `Miniconda <https://docs.conda.io/en/latest/miniconda.html>`_\n for the appropriate OS. Follow the remaining `steps <https://conda.io/projects/conda/en/latest/user-guide/install/index.html#regular-installation>`_\n for the appropriate OS version.\n2. From the terminal, install pip by running: ``conda install -c anaconda pip``\n3. Next, create a new environment for the project with the following.\n\n .. code-block:: console\n\n conda create -n pcrunch-dev\n\n To activate/deactivate the environment, use the following commands.\n\n .. code-block:: console\n\n conda activate pcrunch-dev\n conda deactivate pcrunch-dev\n\n4. Clone the repository:\n ``git clone https://github.com/NREL/pCrunch.git``\n\n5. Navigate to the top level of the repository\n (``<path-to-pCrunch>/pCrunch/``) and install pCrunch as an editable package\n with following commands.\n\n .. code-block:: console\n\n pip install -e '.[dev]'\n\n6. (Preferred) Install the pre-commit hooks to autoformat code, ensuring\n consistent code style across the repository.\n\n .. code-block:: console\n\n pre-commit install\n\nExamples\n--------\n\nFor an up to date example of the core functionalities, see `example.ipynb`. More\nexamples coming soon.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "IO and Post Processing Interface for OpenFAST Results.",
"version": "1.0.5",
"project_urls": {
"Homepage": "https://github.com/NREL/pCrunch"
},
"split_keywords": [
"wind",
"turbine",
"fatigue",
"ultimate",
"aeroelastic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9a21088b32e2c3ce72240d43c73aaf985f8523001c868d3dd0b4d67f7803f348",
"md5": "e5e916f91642d0767a9ed91aae40b8bc",
"sha256": "8e4f56aa9178041847a4ced66852685a4ca2f2d8253cb58a72763575843bf9eb"
},
"downloads": -1,
"filename": "pCrunch-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e5e916f91642d0767a9ed91aae40b8bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5965348,
"upload_time": "2023-08-29T11:15:34",
"upload_time_iso_8601": "2023-08-29T11:15:34.480487Z",
"url": "https://files.pythonhosted.org/packages/9a/21/088b32e2c3ce72240d43c73aaf985f8523001c868d3dd0b4d67f7803f348/pCrunch-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d8d92974717cde0cf76ae63ce126ec0893157c6b604471445f43b50958fd1ab6",
"md5": "f3adcdf6ba0f6f5a0de1c7ce9e8a28dc",
"sha256": "2df1a2f1bf9c892e94523c8b20e626a4ee77306c76ec027350244c524ca8177b"
},
"downloads": -1,
"filename": "pCrunch-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "f3adcdf6ba0f6f5a0de1c7ce9e8a28dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 5914807,
"upload_time": "2023-08-29T11:15:36",
"upload_time_iso_8601": "2023-08-29T11:15:36.907447Z",
"url": "https://files.pythonhosted.org/packages/d8/d9/2974717cde0cf76ae63ce126ec0893157c6b604471445f43b50958fd1ab6/pCrunch-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-29 11:15:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NREL",
"github_project": "pCrunch",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pcrunch"
}
