turtle-loc-oracles


Nameturtle-loc-oracles JSON
Version 0.0.1 PyPI version JSON
download
home_pageNone
SummaryOracles for turtle locomotion (e.g., swimming, walking, etc.)
upload_time2024-09-04 18:16:14
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT License Copyright (c) 2024 Maximilian Stölzle Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords bioinspiration robotics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Turtle Locomotion Oracles

This Python package contains oracles of the movement of turtle limbs during locomotion (e.g., swimming /)
Some oracles are based on real-world observations of turtle locomotion, while others are based on theoretical/template models.

## Installation

Installation is very easy:

Either just clone the repository and install the package (in ediatble mode) using pip.

```bash
pip install -e .
```

or install the package directly from PyPI:

```bash
pip install turtle-loc-oracles
```

## Usage



## Provided Oracles

### Joint-space Oracles

#### Cornelia Turtle Robot Joint Space Trajectory

This oracle provides a joint-space trajectory developed for the Cornelia turtle robot by (van der Geest et al., 2023).
Please refer to the original paper for more information: https://doi.org/10.1038/s41598-023-37904-5

> van der Geest, N., Garcia, L., Borret, F., Nates, R., & Gonzalez, A. (2023).
Soft-robotic green sea turtle (Chelonia mydas) developed to replace animal experimentation provides new insight
into their propulsive strategies. Scientific Reports, 13(1), 11983.

and cite it if you use this oracle in your research.

```bibtex
@article{van2023soft,
  title={Soft-robotic green sea turtle (Chelonia mydas) developed to replace animal experimentation provides new insight into their propulsive strategies},
  author={van der Geest, Nick and Garcia, Lorenzo and Borret, Fraser and Nates, Roy and Gonzalez, Alberto},
  journal={Scientific Reports},
  volume={13},
  number={1},
  pages={11983},
  year={2023},
  publisher={Nature Publishing Group UK London}
}
```

### Task-space Oracles

#### Green Sea Turtle Swimming Task Space Trajectory

This oracle provides a task-space trajectory that was fitted to video recordings of the swimming of Green sea turtles (van der Geest et al., 2022).
Please refer to the original paper for more information: https://doi.org/10.1038/s41598-022-21459-y

> van der Geest, N., Garcia, L., Nates, R., & Godoy, D. A. (2022).
New insight into the swimming kinematics of wild Green sea turtles (Chelonia mydas).
Scientific Reports, 12(1), 18151.

and cite it if you use this oracle in your research.

```bibtex
@article{van2022new,
  title={New insight into the swimming kinematics of wild Green sea turtles (Chelonia mydas)},
  author={van der Geest, Nick and Garcia, Lorenzo and Nates, Roy and Godoy, Daniel A},
  journal={Scientific Reports},
  volume={12},
  number={1},
  pages={18151},
  year={2022},
  publisher={Nature Publishing Group UK London}
}
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "turtle-loc-oracles",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "\"Zach J. Patterson\" <zpatt@csail.mit.edu>",
    "keywords": "bioinspiration, robotics",
    "author": null,
    "author_email": "Maximilian St\u00f6lzle <maximilian@stoelzle.ch>, \"Zach J. Patterson\" <zpatt@csail.mit.edu>",
    "download_url": "https://files.pythonhosted.org/packages/b1/a3/c1ab5645ae86f3ed0575c7898b2c4fbeb58374af3f146a79ff163976b699/turtle_loc_oracles-0.0.1.tar.gz",
    "platform": null,
    "description": "# Turtle Locomotion Oracles\n\nThis Python package contains oracles of the movement of turtle limbs during locomotion (e.g., swimming /)\nSome oracles are based on real-world observations of turtle locomotion, while others are based on theoretical/template models.\n\n## Installation\n\nInstallation is very easy:\n\nEither just clone the repository and install the package (in ediatble mode) using pip.\n\n```bash\npip install -e .\n```\n\nor install the package directly from PyPI:\n\n```bash\npip install turtle-loc-oracles\n```\n\n## Usage\n\n\n\n## Provided Oracles\n\n### Joint-space Oracles\n\n#### Cornelia Turtle Robot Joint Space Trajectory\n\nThis oracle provides a joint-space trajectory developed for the Cornelia turtle robot by (van der Geest et al., 2023).\nPlease refer to the original paper for more information: https://doi.org/10.1038/s41598-023-37904-5\n\n> van der Geest, N., Garcia, L., Borret, F., Nates, R., & Gonzalez, A. (2023).\nSoft-robotic green sea turtle (Chelonia mydas) developed to replace animal experimentation provides new insight\ninto their propulsive strategies. Scientific Reports, 13(1), 11983.\n\nand cite it if you use this oracle in your research.\n\n```bibtex\n@article{van2023soft,\n  title={Soft-robotic green sea turtle (Chelonia mydas) developed to replace animal experimentation provides new insight into their propulsive strategies},\n  author={van der Geest, Nick and Garcia, Lorenzo and Borret, Fraser and Nates, Roy and Gonzalez, Alberto},\n  journal={Scientific Reports},\n  volume={13},\n  number={1},\n  pages={11983},\n  year={2023},\n  publisher={Nature Publishing Group UK London}\n}\n```\n\n### Task-space Oracles\n\n#### Green Sea Turtle Swimming Task Space Trajectory\n\nThis oracle provides a task-space trajectory that was fitted to video recordings of the swimming of Green sea turtles (van der Geest et al., 2022).\nPlease refer to the original paper for more information: https://doi.org/10.1038/s41598-022-21459-y\n\n> van der Geest, N., Garcia, L., Nates, R., & Godoy, D. A. (2022).\nNew insight into the swimming kinematics of wild Green sea turtles (Chelonia mydas).\nScientific Reports, 12(1), 18151.\n\nand cite it if you use this oracle in your research.\n\n```bibtex\n@article{van2022new,\n  title={New insight into the swimming kinematics of wild Green sea turtles (Chelonia mydas)},\n  author={van der Geest, Nick and Garcia, Lorenzo and Nates, Roy and Godoy, Daniel A},\n  journal={Scientific Reports},\n  volume={12},\n  number={1},\n  pages={18151},\n  year={2022},\n  publisher={Nature Publishing Group UK London}\n}\n```\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 Maximilian St\u00f6lzle  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Oracles for turtle locomotion (e.g., swimming, walking, etc.)",
    "version": "0.0.1",
    "project_urls": {
        "Bug Reports": "https://github.com/crush-robotics/turtle-locomotion-oracles/issues",
        "Homepage": "https://github.com/crush-robotics/turtle-locomotion-oracles",
        "Source": "https://github.com/crush-robotics/turtle-locomotion-oracles/"
    },
    "split_keywords": [
        "bioinspiration",
        " robotics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d583cfe19358dade776cd03ad97a28252e1ae67ed13b5e1fcb8697443ef36959",
                "md5": "86126fe7a6da19c267483cbd7cc519c5",
                "sha256": "7ee02c69438414c36a5b94f7acd25d42d9db4c316e2e8e82e53e569a07d92f45"
            },
            "downloads": -1,
            "filename": "turtle_loc_oracles-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "86126fe7a6da19c267483cbd7cc519c5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 15324,
            "upload_time": "2024-09-04T18:16:12",
            "upload_time_iso_8601": "2024-09-04T18:16:12.769148Z",
            "url": "https://files.pythonhosted.org/packages/d5/83/cfe19358dade776cd03ad97a28252e1ae67ed13b5e1fcb8697443ef36959/turtle_loc_oracles-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b1a3c1ab5645ae86f3ed0575c7898b2c4fbeb58374af3f146a79ff163976b699",
                "md5": "e85a1c41422cb68f55dcc60eb486b072",
                "sha256": "d10b44df1eecca52845f4336e3b9cec008df48c91abc7552936895c88cebac9c"
            },
            "downloads": -1,
            "filename": "turtle_loc_oracles-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "e85a1c41422cb68f55dcc60eb486b072",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 17002,
            "upload_time": "2024-09-04T18:16:14",
            "upload_time_iso_8601": "2024-09-04T18:16:14.167714Z",
            "url": "https://files.pythonhosted.org/packages/b1/a3/c1ab5645ae86f3ed0575c7898b2c4fbeb58374af3f146a79ff163976b699/turtle_loc_oracles-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-04 18:16:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "crush-robotics",
    "github_project": "turtle-locomotion-oracles",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "turtle-loc-oracles"
}
        
Elapsed time: 1.69568s