# Parflow Simulation Modeler
## License
Free software: Apache Software License
## Installing
Create virtual environment
```bash
python -m venv .venv
source .venv/bin/activate
```
Build and install the Vue components
```bash
export NODE_OPTIONS=--openssl-legacy-provider
cd vue-components
npm i
npm run build
cd -
```
Install the application
```bash
pip install -e .
```
Run the application
```bash
pf-simulation-modeler --help
pf-simulation-modeler --server --port 1234 -D data/database/ -S data/share/ -O data/output/
```
## Documentation
- [Engine](docs/engine.md) Structure
- [Snippets](docs/snippets.md)
- [UI](docs/ui.md) Structure
- Server [`state` and `ctrl`](docs/server.md) variables
## File Structure
```bash
- pf_simulation_modeler/
- app/
- engine/
- model/ # Simput model/UI definitions
- snippets/ # Logic for page code snippets
- engine.py # Main logic handler
- ... # Logic components (generally specific to pages)
- ui/
- ui.py # Main UI handler
- ... # UI components (pages)
- main.py # Entry point
- module/ # Serves the compiled Vue components
- widgets/ # Python wrapper around the Vue components
- vue-components/src/components/ # Custom Vue components
- FileDatabase/ # FileDatabase Vue component
- index.vue # Vue component
- script.js # JS logic
- template.html # HTML template
- ... # Other Vue components
- data/ # Data files (used for cli args)
- database/ # FileDatabase data
- output/ # Project Output data
- share/ # Shared data
```
Raw data
{
"_id": null,
"home_page": "",
"name": "pf-simulation-modeler",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Python,Interactive,Web,Application,Framework",
"author": "Kitware Inc.",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/95/ee/6149b1f6a3bc646f8781e0ea542efeb385b21e1c09d120ea1aa7f18d0115/pf-simulation-modeler-0.1.1.tar.gz",
"platform": null,
"description": "# Parflow Simulation Modeler\n\n## License\n\nFree software: Apache Software License\n\n## Installing\n\nCreate virtual environment\n\n```bash\npython -m venv .venv\nsource .venv/bin/activate\n```\n\nBuild and install the Vue components\n\n```bash\nexport NODE_OPTIONS=--openssl-legacy-provider\ncd vue-components\nnpm i\nnpm run build\ncd -\n```\n\nInstall the application\n\n```bash\npip install -e .\n```\n\nRun the application\n\n```bash\npf-simulation-modeler --help\npf-simulation-modeler --server --port 1234 -D data/database/ -S data/share/ -O data/output/\n```\n\n## Documentation\n\n- [Engine](docs/engine.md) Structure\n - [Snippets](docs/snippets.md)\n- [UI](docs/ui.md) Structure\n- Server [`state` and `ctrl`](docs/server.md) variables\n\n## File Structure\n\n```bash\n- pf_simulation_modeler/\n - app/\n - engine/\n - model/ # Simput model/UI definitions\n - snippets/ # Logic for page code snippets\n - engine.py # Main logic handler\n - ... # Logic components (generally specific to pages)\n\n - ui/\n - ui.py # Main UI handler\n - ... # UI components (pages)\n\n - main.py # Entry point\n\n - module/ # Serves the compiled Vue components\n - widgets/ # Python wrapper around the Vue components\n\n- vue-components/src/components/ # Custom Vue components\n - FileDatabase/ # FileDatabase Vue component\n - index.vue # Vue component\n - script.js # JS logic\n - template.html # HTML template\n\n - ... # Other Vue components\n\n- data/ # Data files (used for cli args)\n - database/ # FileDatabase data\n - output/ # Project Output data\n - share/ # Shared data\n```\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Parflow Simulation modeler",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [
"python",
"interactive",
"web",
"application",
"framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c5c5548b209fb6480b15a6e5dad794dd262a915a9449d70e07d46a58fbac3168",
"md5": "d6d843baa5a44ed012d45e890351952c",
"sha256": "4107f9777345b14ab5780c3919e6102a9a6845fd8d2d9b34fbf8e3e8d93c0821"
},
"downloads": -1,
"filename": "pf_simulation_modeler-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6d843baa5a44ed012d45e890351952c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 90709,
"upload_time": "2023-07-26T18:50:55",
"upload_time_iso_8601": "2023-07-26T18:50:55.759172Z",
"url": "https://files.pythonhosted.org/packages/c5/c5/548b209fb6480b15a6e5dad794dd262a915a9449d70e07d46a58fbac3168/pf_simulation_modeler-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95ee6149b1f6a3bc646f8781e0ea542efeb385b21e1c09d120ea1aa7f18d0115",
"md5": "a02a696313d8cbd41d3c820006002c16",
"sha256": "0805f16271f12ef9dc9dfa2428c08d61302a70790368fbec5f7e919ee8939b8f"
},
"downloads": -1,
"filename": "pf-simulation-modeler-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "a02a696313d8cbd41d3c820006002c16",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 71113,
"upload_time": "2023-07-26T18:50:56",
"upload_time_iso_8601": "2023-07-26T18:50:56.814602Z",
"url": "https://files.pythonhosted.org/packages/95/ee/6149b1f6a3bc646f8781e0ea542efeb385b21e1c09d120ea1aa7f18d0115/pf-simulation-modeler-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-26 18:50:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pf-simulation-modeler"
}
JSON