SPARC Dataset Creation
======================
A package to help with creating SPARC datasets.
Currently, support is available to create scaffold based SPARC datasets.
Install
-------
SPARC dataset tools can be installed from PyPi.org with the following command::
pip install sparc-dataset-tools
Usage
-----
How to use (can also be found using :code:`create-scaffold-dataset -h`):
usage: :code:`create-scaffold-dataset [-h] dataset_dir mesh_config_file argon_document`
Create a Scaffold based SPARC dataset from a scaffold description file and an Argon document.
**positional arguments:**
================== =================================================
dataset_dir root directory for new dataset.
mesh_config_file mesh config json file to generate scaffold.
argon_document argon document file to generate webGL files.
================== =================================================
**optional arguments:**
============= =================================
-h, --help show this help message and exit
============= =================================
Run
---
To run the application create a virtual environment.
::
python -m venv venv_sparc
Activate the virtual environment::
source venv_sparc/bin/activate
For bash shells, or::
venv_sparc\Scripts\activate
For a windows :code:`cmd` prompt.
With the activated virtual environment install the package.
::
pip install sparc-dataset-tools
Then execute the application to print out the usage information to test the script.
::
create-scaffold-dataset -h
Examples:
---------
::
create-scaffold-dataset <dataset_dir> <mesh_config_file> <argon_document>
License
=======
::
Copyright 2022 University of Auckland
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Raw data
{
"_id": null,
"home_page": "https://github.com/ABI-Software/sparc-dataset-tools.git",
"name": "sparc-dataset-tools",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Hugh Sorby",
"author_email": "h.sorby@auckland.ac.nz",
"download_url": null,
"platform": null,
"description": "\nSPARC Dataset Creation\n======================\n\nA package to help with creating SPARC datasets.\nCurrently, support is available to create scaffold based SPARC datasets.\n\nInstall\n-------\n\nSPARC dataset tools can be installed from PyPi.org with the following command::\n\n pip install sparc-dataset-tools\n\nUsage\n-----\n\nHow to use (can also be found using :code:`create-scaffold-dataset -h`):\n\nusage: :code:`create-scaffold-dataset [-h] dataset_dir mesh_config_file argon_document`\n\nCreate a Scaffold based SPARC dataset from a scaffold description file and an Argon document.\n\n**positional arguments:**\n\n================== =================================================\n dataset_dir root directory for new dataset.\n mesh_config_file mesh config json file to generate scaffold.\n argon_document argon document file to generate webGL files.\n================== =================================================\n\n**optional arguments:**\n\n============= =================================\n -h, --help show this help message and exit\n============= =================================\n\nRun\n---\n\nTo run the application create a virtual environment.\n\n::\n\n python -m venv venv_sparc\n\nActivate the virtual environment::\n\n source venv_sparc/bin/activate\n\nFor bash shells, or::\n\n venv_sparc\\Scripts\\activate\n\nFor a windows :code:`cmd` prompt.\n\nWith the activated virtual environment install the package.\n\n::\n\n pip install sparc-dataset-tools\n\nThen execute the application to print out the usage information to test the script.\n\n::\n\n create-scaffold-dataset -h\n\nExamples:\n---------\n\n::\n\n create-scaffold-dataset <dataset_dir> <mesh_config_file> <argon_document>\n\nLicense\n=======\n\n::\n\n\n Copyright 2022 University of Auckland\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n \n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "A collection of tools to help with creating SPARC datasets.",
"version": "0.2.5",
"project_urls": {
"Homepage": "https://github.com/ABI-Software/sparc-dataset-tools.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "02806f772add885a9e559659dba58be03666cb94286dcd280fd92e663b40b180",
"md5": "50a7ca60f2800597d6ac886e5b8f02d8",
"sha256": "374ea5e90fc4a5bc75d55a0520eec99544b42a1e794402103bbe68e3f64e6f2d"
},
"downloads": -1,
"filename": "sparc_dataset_tools-0.2.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "50a7ca60f2800597d6ac886e5b8f02d8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4637,
"upload_time": "2024-08-21T04:03:29",
"upload_time_iso_8601": "2024-08-21T04:03:29.295977Z",
"url": "https://files.pythonhosted.org/packages/02/80/6f772add885a9e559659dba58be03666cb94286dcd280fd92e663b40b180/sparc_dataset_tools-0.2.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 04:03:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ABI-Software",
"github_project": "sparc-dataset-tools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "sparc-dataset-tools"
}
JSON
