RAID documentation =================== Installation Guide ------------------ On a windows command cell copy the following : .. code-block:: shell git clone https://gitlab.com/bwtcreativetech/19029_raid_nr/tree/demo_test/docs cd 19029_RAID_NR conda create -n raid_env python=3.5 conda install --file requirements.txt Getting Started --------------- * Navigate to flask_UI > info open the ipconfigFile.txt and change the value accordingly. For more information you can visit. * In the flask_UI directory and having your virtual env already activated run. .. code-block:: shell start startUI.bat * You should see Flask running in a new command prompt window.You can visit your http//:localhost:4000 (default port) and use the UI. User Guide ---------- For the user guide, visit the `user_guide`_ section in GitLab repo. Examples -------- For examples and demos, see the `examples`_ GitLab repo. .. toctree:: :maxdepth: 2 :caption: Contents: Grid Transformations ==================== Collection of functions to operate Grid Functions -------------- .. automodule:: raidnr.bwgrid.grid_transformations :members: Grid Class ---------- .. automodule:: raidnr.bwgrid.grid :members: Core Functions ================== Alignment ---------- .. automodule:: raidnr.core.alignment :members: Corridor -------- .. automodule:: raidnr.core.corridor :members: Frenet Frame ------------ .. automodule:: raidnr.core.frenet_frame :members: Rail Designer ------------- .. automodule:: raidnr.core.rail_designer :members: Plane Class ----------- .. automodule:: raidnr.core.plane :members: Speed Curve ----------- .. automodule:: raidnr.core.speed_curve :members: Manager ================== Design Manager -------------- .. automodule:: raidnr.manager.design_manager :members: Remapper -------- .. automodule:: raidnr.manager.remapper :members: Utility ================== Dashboards ---------- .. automodule:: raidnr.util.dashboards :members: External Methods ---------------- .. automodule:: raidnr.util.ext_methods :members: Least Cost Path --------------- .. automodule:: raidnr.util.least_cost_path :members: Spatial Toolbox --------------- .. automodule:: raidnr.util.SpatialToolbox :members: Vertical Alignment ------------------ .. automodule:: raidnr.util.vertical_alignment :members: Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` .. _examples: https://github.com/gboeing/osmnx-examples .. _user_guide: https://github.com/gboeing/osmnx-examples