| Name | fhy-core JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | None |
| Summary | Core utilities for the FhY compiler infrastructure. |
| upload_time | 2024-11-12 23:45:05 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Copyright (c) 2024 FhY Developers Christopher Priebe <cpriebe@ucsd.edu> Hadi S Esmaeilzadeh <hadi@ucsd.edu> All Rights Reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
compiler
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# *FhY* Core
*FhY* Core is a collection of utilities for *FhY* and other parts of the compiler.
| Utility | Description |
| :--------------------------------------: | :--------------------------------------------------------------------- |
| Identifier | Unique naming class with a non-unique name hint and a unique ID. |
| Error | Custom error registration and core errors for the compiler. |
| Expression | General expression represented as an AST with a parser and printer. |
| Constraint | General logical constraint. |
| Parameter | Real, integer, orginal, categorical, and permutation parameters. |
| Types | Core type system for the compiler. |
| Memory Instance | Extensible record for an instance of data in memory. |
| Symbol Table | Nested symbol table. |
| _General Utility_ - Python 3.11 Enums | String and integer enum types only introduced in Python 3.11 |
| _General Utility_ - Stack | General stack utility that wraps `deque`. |
| _General Utility_ - POSET | General partially ordered set utility represented as a directed graph. |
| _General Utility_ - Lattice | General lattice (order theory) utility represented with a POSET. |
| _General Utility_ - Dictionary Utilities | Additional dictionary helper functions. |
## Table of Contents
- [Installing *FhY* Core](#installing-fhy-core)
- [Install *FhY* Core from PyPi](#install-fhy-core-from-pypi)
- [Build *FhY* Core from Source Code](#build-fhy-core-from-source-code)
- [Contributing - For Developers](#contributing---for-developers)
### Install *FhY* Core from PyPi
**Coming Soon**
### Build *FhY* Core from Source Code
1. Clone the repository from GitHub.
```bash
git clone https://github.com/actlab-fhy/FhY-core.git
```
2. Create and prepare a Python virtual environment.
```bash
cd FhY-core
python -m venv .venv
source .venv/bin/activate
python -m pip install -U pip
pip install setuptools wheel
```
3. Install *FhY*.
```bash
# Standard Installation
pip install .
# For contributors
pip install ".[dev]"
```
## Contributing - For Developers
Want to start contributing the *FhY* Core? Please take a look at our
[contribution guide](CONTRIBUTING.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "fhy-core",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Christopher Priebe <cpriebe@ucsd.edu>",
"keywords": "Compiler",
"author": null,
"author_email": "Christopher Priebe <cpriebe@ucsd.edu>",
"download_url": "https://files.pythonhosted.org/packages/6b/eb/02024f913f629d54e2eb62f73eb36a29da34d67118ce693cb2b01146812d/fhy_core-0.0.2.tar.gz",
"platform": null,
"description": "# *FhY* Core\n\n*FhY* Core is a collection of utilities for *FhY* and other parts of the compiler.\n\n| Utility | Description |\n| :--------------------------------------: | :--------------------------------------------------------------------- |\n| Identifier | Unique naming class with a non-unique name hint and a unique ID. |\n| Error | Custom error registration and core errors for the compiler. |\n| Expression | General expression represented as an AST with a parser and printer. |\n| Constraint | General logical constraint. |\n| Parameter | Real, integer, orginal, categorical, and permutation parameters. |\n| Types | Core type system for the compiler. |\n| Memory Instance | Extensible record for an instance of data in memory. |\n| Symbol Table | Nested symbol table. |\n| _General Utility_ - Python 3.11 Enums | String and integer enum types only introduced in Python 3.11 |\n| _General Utility_ - Stack | General stack utility that wraps `deque`. |\n| _General Utility_ - POSET | General partially ordered set utility represented as a directed graph. |\n| _General Utility_ - Lattice | General lattice (order theory) utility represented with a POSET. |\n| _General Utility_ - Dictionary Utilities | Additional dictionary helper functions. |\n\n\n## Table of Contents\n- [Installing *FhY* Core](#installing-fhy-core)\n - [Install *FhY* Core from PyPi](#install-fhy-core-from-pypi)\n - [Build *FhY* Core from Source Code](#build-fhy-core-from-source-code)\n- [Contributing - For Developers](#contributing---for-developers)\n\n### Install *FhY* Core from PyPi\n**Coming Soon**\n\n### Build *FhY* Core from Source Code\n\n1. Clone the repository from GitHub.\n\n ```bash\n git clone https://github.com/actlab-fhy/FhY-core.git\n ```\n\n2. Create and prepare a Python virtual environment.\n\n ```bash\n cd FhY-core\n python -m venv .venv\n source .venv/bin/activate\n python -m pip install -U pip\n pip install setuptools wheel\n ```\n\n3. Install *FhY*.\n\n ```bash\n # Standard Installation\n pip install .\n\n # For contributors\n pip install \".[dev]\"\n ```\n\n## Contributing - For Developers\nWant to start contributing the *FhY* Core? Please take a look at our\n[contribution guide](CONTRIBUTING.md)\n",
"bugtrack_url": null,
"license": "Copyright (c) 2024 FhY Developers Christopher Priebe <cpriebe@ucsd.edu> Hadi S Esmaeilzadeh <hadi@ucsd.edu> All Rights Reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \u201cAS IS\u201d AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "Core utilities for the FhY compiler infrastructure.",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/actlab-fhy/FhY-core",
"Issues": "https://github.com/actlab-fhy/FhY-core/issues"
},
"split_keywords": [
"compiler"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d798b2fc8c54a3e4de6a199116f0fe0c4f849576feaa3c0f062938f7da1a6536",
"md5": "466c78e5329740ace221f2a5959eb64f",
"sha256": "4a1def0c6fdbcf53b821f3c27f4dfafdee7c59ed36b6537e554d126ccf2303f3"
},
"downloads": -1,
"filename": "fhy_core-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "466c78e5329740ace221f2a5959eb64f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 33029,
"upload_time": "2024-11-12T23:45:04",
"upload_time_iso_8601": "2024-11-12T23:45:04.112641Z",
"url": "https://files.pythonhosted.org/packages/d7/98/b2fc8c54a3e4de6a199116f0fe0c4f849576feaa3c0f062938f7da1a6536/fhy_core-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6beb02024f913f629d54e2eb62f73eb36a29da34d67118ce693cb2b01146812d",
"md5": "19319311b679e917554d34b0354f56f1",
"sha256": "b4d1cb5314acb6b628c44804c48ec6ac0ea24aa883801ce3f051c3f9624705b4"
},
"downloads": -1,
"filename": "fhy_core-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "19319311b679e917554d34b0354f56f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 39985,
"upload_time": "2024-11-12T23:45:05",
"upload_time_iso_8601": "2024-11-12T23:45:05.671335Z",
"url": "https://files.pythonhosted.org/packages/6b/eb/02024f913f629d54e2eb62f73eb36a29da34d67118ce693cb2b01146812d/fhy_core-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-12 23:45:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "actlab-fhy",
"github_project": "FhY-core",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "fhy-core"
}
