gtbook
================
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
The book can be found at <https://www.roboticsbook.org> and has the
following chapters:
- [Introduction](https://www.roboticsbook.org/intro.html)
- [A Trash Sorting
Robot](https://www.roboticsbook.org/S20_sorter_intro.html)
(`discrete`)
- [A Robot Vacuum
Cleaner](https://www.roboticsbook.org/S30_vacuum_intro.html)
(`vacuum`)
- [Warehouse Robots in
2D](https://www.roboticsbook.org/S40_logistics_intro.html)
(`logistics`)
- [A Mobile Robot with Simple
Kinematics](https://www.roboticsbook.org/S50_diffdrive_intro.html)
(`diffdrive`)
- [Autonomous
Vehicles](https://www.roboticsbook.org/S60_driving_intro.html)
(`driving`)
- [Autonomous Drones in
3D](https://www.roboticsbook.org/S70_drone_intro.html) (`drone`)
The structure of gtbook mirrors this organization, and then has a few
more support modules for displaying graphs inside notebooks and for
running the code in the book. The gtbook modules are listed above
alongside the chapter.
## How to use
In the book chapters, we should have a cell that fetches the latest
version using pip:
``` bash
%pip install -q -U gtbook
```
The above automatically installs other libraries on colab, e.g., gtsam
and plotly.
You also needs a cell that imports what you need in a particular
section, for example:
``` python
from gtbook.display import show
from gtbook.discrete import Variables
```
Further usage examples of these and more functions are given in the
module documentation itself.
There are also some command line tools defined in the `cli` module.
## Notes for development
> Mostly for Frank as he adds to the library.
- For version 2 of nbdev in a local conda environment called nbdev2. It
can be re-created with `conda env create -f environment.yml`.
- I used `conda install -c fastai nbdev` to install nbdev in there as
well, but the github workflow uses `pip install nbdev` so I can just
use one channel.
- `pip install -e .` for local install of the remaining modules
specified in the settings.ini file
- to preview the docs do `nbdev_preview`
- to push a new version, use `nbdev_prepare` and then push.
To release a new version:
- `nbdev_bump_version`
- `nbdev_pypi`
Raw data
{
"_id": null,
"home_page": "https://github.com/gtbook/gtbook/tree/master/",
"name": "gtbook",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "python, nbdev",
"author": "Frank Dellaert",
"author_email": "dellaert@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/77/85/049b09ab0182225e9b853939dbb62d5e5518086c37bf7ca257659e49d4e5/gtbook-0.0.38.tar.gz",
"platform": null,
"description": "gtbook\n================\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\nThe book can be found at <https://www.roboticsbook.org> and has the\nfollowing chapters:\n\n- [Introduction](https://www.roboticsbook.org/intro.html)\n- [A Trash Sorting\n Robot](https://www.roboticsbook.org/S20_sorter_intro.html)\n (`discrete`)\n- [A Robot Vacuum\n Cleaner](https://www.roboticsbook.org/S30_vacuum_intro.html)\n (`vacuum`)\n- [Warehouse Robots in\n 2D](https://www.roboticsbook.org/S40_logistics_intro.html)\n (`logistics`)\n- [A Mobile Robot with Simple\n Kinematics](https://www.roboticsbook.org/S50_diffdrive_intro.html)\n (`diffdrive`)\n- [Autonomous\n Vehicles](https://www.roboticsbook.org/S60_driving_intro.html)\n (`driving`)\n- [Autonomous Drones in\n 3D](https://www.roboticsbook.org/S70_drone_intro.html) (`drone`)\n\nThe structure of gtbook mirrors this organization, and then has a few\nmore support modules for displaying graphs inside notebooks and for\nrunning the code in the book. The gtbook modules are listed above\nalongside the chapter.\n\n## How to use\n\nIn the book chapters, we should have a cell that fetches the latest\nversion using pip:\n\n``` bash\n%pip install -q -U gtbook\n```\n\nThe above automatically installs other libraries on colab, e.g., gtsam\nand plotly.\n\nYou also needs a cell that imports what you need in a particular\nsection, for example:\n\n``` python\nfrom gtbook.display import show\nfrom gtbook.discrete import Variables\n```\n\nFurther usage examples of these and more functions are given in the\nmodule documentation itself.\n\nThere are also some command line tools defined in the `cli` module.\n\n## Notes for development\n\n> Mostly for Frank as he adds to the library.\n\n- For version 2 of nbdev in a local conda environment called nbdev2. It\n can be re-created with `conda env create -f environment.yml`.\n- I used `conda install -c fastai nbdev` to install nbdev in there as\n well, but the github workflow uses `pip install nbdev` so I can just\n use one channel.\n- `pip install -e .` for local install of the remaining modules\n specified in the settings.ini file\n- to preview the docs do `nbdev_preview`\n- to push a new version, use `nbdev_prepare` and then push.\n\nTo release a new version:\n\n- `nbdev_bump_version`\n- `nbdev_pypi`\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Frank Dellaerts book support lib, made with nbdev",
"version": "0.0.38",
"project_urls": {
"Homepage": "https://github.com/gtbook/gtbook/tree/master/"
},
"split_keywords": [
"python",
" nbdev"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "98c68253734e36744d2a12e054572a57b3b6b19dbeb31f475081147f21a7c3f7",
"md5": "6446500fa2bd9ec9d4f70342a7145c89",
"sha256": "f8f2747ce4303908797f88453d8cd1b4f02fcbedb59bd41f062b3b4f640bd530"
},
"downloads": -1,
"filename": "gtbook-0.0.38-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6446500fa2bd9ec9d4f70342a7145c89",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 33550,
"upload_time": "2024-04-28T14:08:50",
"upload_time_iso_8601": "2024-04-28T14:08:50.772038Z",
"url": "https://files.pythonhosted.org/packages/98/c6/8253734e36744d2a12e054572a57b3b6b19dbeb31f475081147f21a7c3f7/gtbook-0.0.38-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7785049b09ab0182225e9b853939dbb62d5e5518086c37bf7ca257659e49d4e5",
"md5": "d261f8f7d3c8cc974d501e6db4ee2801",
"sha256": "3f9a77e1dd9583bac245fac96d31cac4b0010d1664b9955d063d9ea0a9bff892"
},
"downloads": -1,
"filename": "gtbook-0.0.38.tar.gz",
"has_sig": false,
"md5_digest": "d261f8f7d3c8cc974d501e6db4ee2801",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 31978,
"upload_time": "2024-04-28T14:08:52",
"upload_time_iso_8601": "2024-04-28T14:08:52.979091Z",
"url": "https://files.pythonhosted.org/packages/77/85/049b09ab0182225e9b853939dbb62d5e5518086c37bf7ca257659e49d4e5/gtbook-0.0.38.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-28 14:08:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gtbook",
"github_project": "gtbook",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gtbook"
}
JSON
