gocadgo

Name	gocadgo JSON
Version	1.1.1 JSON
	download
home_page	None
Summary	A basic network-based solver to propagate through heat exchanger cell properties
upload_time	2024-12-02 05:19:25
maintainer	None
docs_url	None
author	Marina Kovaleva
requires_python	>=3
license	MIT
keywords	cfd heat-loss heat-exchanger
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # gocadgo


## To Do  
[] Add depedencies <br>
[] Add example code and readme. <br>
[] Correct code for P and Q calcs
[] ensure network is connected correctly and propagates 
[] get the fields to actually print (somehow)

## Installation

```bash
pip install gocadgo
```
In testing and planning stages - do not use. 


## Basic Usage

```python
    # set boundary conditions: 
    my_inlet = set_boundary(T_in=300,
                 P_in=101325,
                 m_in=0.1, 
                 P_out=101325,
                 T_out=300, 
                 gas_type="N2"
                 )
    
    # create mesh and run network: 
    sky_train = Network(8, 8, 20, my_inlet)
    
    # display fields of interest: 
    show_fields(sky_train, 'q')
```
Explain here

### Function Choices

Explain functions you can call

### Function Parameters

The `func1` and `func2` functions take in the following parameters:

##### Positional

- **heyword** : Add meaning here

##### Keyword (Optional)

- **keyword** : add meaning here

For assistance with parameter selection refer to [RFC 9106](https://www.rfc-editor.org/rfc/rfc9106.html), in particular "Chapter 4: Parameter Choice".

### Function Exceptions

### Uploading to PyPi
<b> Note:  ``setup.py`` is now depreciated. Instead, use pypa/build, pypa/installer or other standards-based tools. </b>

Check distribution: 
```console 
python setup.py sdist bdist_wheel
twine check dist/*
```

Follow instructions for a setuptools build:
https://packaging.python.org/en/latest/tutorials/packaging-projects/

Get API token on link below: 
https://pypi.org/manage/account/#api-tokens

Activate your local environment and shell session use: 
```console
export TWINE_PASSWORD=<your-token>
export TWINE_USERNAME=__token__
```

Upload to Test PyPi:
```console
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
```

Upload to PyPi:
```console
twine upload dist/*
```

Exceptions generated by the underlying Argon2 hashing function are raised under the `Argon2Error` class which can be imported as follows:

```python
from pyargon2 import Argon2Error
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "gocadgo",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3",
    "maintainer_email": null,
    "keywords": "cfd, heat-loss, heat-exchanger",
    "author": "Marina Kovaleva",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/9f/63/fde8feb6fbe0b907be95fc096715f8d92874cdd73f4726ae8c8195d832aa/gocadgo-1.1.1.tar.gz",
    "platform": null,
    "description": "# gocadgo\n\n\n## To Do  \n[] Add depedencies <br>\n[] Add example code and readme. <br>\n[] Correct code for P and Q calcs\n[] ensure network is connected correctly and propagates \n[] get the fields to actually print (somehow)\n\n## Installation\n\n```bash\npip install gocadgo\n```\nIn testing and planning stages - do not use. \n\n\n## Basic Usage\n\n```python\n    # set boundary conditions: \n    my_inlet = set_boundary(T_in=300,\n                 P_in=101325,\n                 m_in=0.1, \n                 P_out=101325,\n                 T_out=300, \n                 gas_type=\"N2\"\n                 )\n    \n    # create mesh and run network: \n    sky_train = Network(8, 8, 20, my_inlet)\n    \n    # display fields of interest: \n    show_fields(sky_train, 'q')\n```\nExplain here\n\n### Function Choices\n\nExplain functions you can call\n\n### Function Parameters\n\nThe `func1` and `func2` functions take in the following parameters:\n\n##### Positional\n\n- **heyword** : Add meaning here\n\n##### Keyword (Optional)\n\n- **keyword** : add meaning here\n\nFor assistance with parameter selection refer to [RFC 9106](https://www.rfc-editor.org/rfc/rfc9106.html), in particular \"Chapter 4: Parameter Choice\".\n\n### Function Exceptions\n\n### Uploading to PyPi\n<b> Note:  ``setup.py`` is now depreciated. Instead, use pypa/build, pypa/installer or other standards-based tools. </b>\n\nCheck distribution: \n```console \npython setup.py sdist bdist_wheel\ntwine check dist/*\n```\n\nFollow instructions for a setuptools build:\nhttps://packaging.python.org/en/latest/tutorials/packaging-projects/\n\nGet API token on link below: \nhttps://pypi.org/manage/account/#api-tokens\n\nActivate your local environment and shell session use: \n```console\nexport TWINE_PASSWORD=<your-token>\nexport TWINE_USERNAME=__token__\n```\n\nUpload to Test PyPi:\n```console\ntwine upload --repository-url https://test.pypi.org/legacy/ dist/*\n```\n\nUpload to PyPi:\n```console\ntwine upload dist/*\n```\n\nExceptions generated by the underlying Argon2 hashing function are raised under the `Argon2Error` class which can be imported as follows:\n\n```python\nfrom pyargon2 import Argon2Error\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A basic network-based solver to propagate through heat exchanger cell properties",
    "version": "1.1.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/marina8888/gocadgo/issues",
        "Homepage": "https://github.com/marina8888/gocadgo"
    },
    "split_keywords": [
        "cfd",
        " heat-loss",
        " heat-exchanger"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "650e6d7478c805f830f4db1006f85a62a1beed4b88efdecec75af60ae6b05f19",
                "md5": "8ebf3f813c4f51d8477317aca0104f11",
                "sha256": "e4f289cb05b79267df1c1667e08eceb6084ebb4308bccc3445610c14298dd4cf"
            },
            "downloads": -1,
            "filename": "gocadgo-1.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8ebf3f813c4f51d8477317aca0104f11",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3",
            "size": 6646,
            "upload_time": "2024-12-02T05:19:23",
            "upload_time_iso_8601": "2024-12-02T05:19:23.724188Z",
            "url": "https://files.pythonhosted.org/packages/65/0e/6d7478c805f830f4db1006f85a62a1beed4b88efdecec75af60ae6b05f19/gocadgo-1.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9f63fde8feb6fbe0b907be95fc096715f8d92874cdd73f4726ae8c8195d832aa",
                "md5": "8b4bd6e084e9c9b64ec66fa77b5e76fa",
                "sha256": "2a1638710e167203342ae4469f8ff685e8d37432e4c8c21a7e5ff76a614e1e75"
            },
            "downloads": -1,
            "filename": "gocadgo-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "8b4bd6e084e9c9b64ec66fa77b5e76fa",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3",
            "size": 5462,
            "upload_time": "2024-12-02T05:19:25",
            "upload_time_iso_8601": "2024-12-02T05:19:25.383182Z",
            "url": "https://files.pythonhosted.org/packages/9f/63/fde8feb6fbe0b907be95fc096715f8d92874cdd73f4726ae8c8195d832aa/gocadgo-1.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-02 05:19:25",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "marina8888",
    "github_project": "gocadgo",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "gocadgo"
}