From 973d1b907296e5e108aeafcb6634771e58f1bde2 Mon Sep 17 00:00:00 2001 From: cslotboom <50510141+cslotboom@users.noreply.github.com> Date: Sat, 16 Jul 2022 19:46:36 -0700 Subject: [PATCH] Updating index --- doc/readthedocs/index.rst | 1 + doc/readthedocs/source/index.rst | 90 -------------------------------- 2 files changed, 1 insertion(+), 90 deletions(-) delete mode 100644 doc/readthedocs/source/index.rst diff --git a/doc/readthedocs/index.rst b/doc/readthedocs/index.rst index c050048..e2bce17 100644 --- a/doc/readthedocs/index.rst +++ b/doc/readthedocs/index.rst @@ -69,6 +69,7 @@ A simple script is shown below: rst/builder rst/analysis rst/diagram + rst/environment rst/postprocess ============= diff --git a/doc/readthedocs/source/index.rst b/doc/readthedocs/source/index.rst deleted file mode 100644 index 2a7bcd6..0000000 --- a/doc/readthedocs/source/index.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. Hysteresis documentation master file, created by - sphinx-quickstart on Thu Dec 31 18:57:31 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -PlaneSections Documentation -====================================== -PlaneSections is a lightweight beam bending library built on `OpenSeesPy `_. -The goal of PlaneSections is to quickly run beam anayses, and create outputs to document structural calculations. -The following website documents all classes and functions the user can access in PlaneSections. - - -Module Summaries -================ -- The Builder module is used to create the beam and beam elements. The beam class is the core class of the module, and the one the user interacts with the most. -- The Analysis module is used to analyze the beam using OpenSeesPy and document the results. -- The Diagram module is used to plot representations of the beam. -- The Postprocess module is used to plot outputs of the analysis, including force diagrams and deflections - -.. note:: - The core classes and API are complete, but development is still in progress. Expect some sytax changes before final release. Deprication warnings - will be given for any breaking changes. - -Install using: - -.. code :: python - - pip install planesections - -A simple script is shown below: - -.. code :: python - - import planesections as ps - import numpy as np - - # Define node locations, and support conditions - L = 5 - beam = ps.newEulerBeam2D(L) - - # Define beam and fixities - pinned = [1,1,0] - beam.setFixity(L*0.1, pinned, label = '1') - beam.setFixity(L*0.9, pinned) - - # Define loads - Pz = -1 - beam.addVerticalLoad(0, Pz, label = 'A') - beam.addVerticalLoad(L*0.5, 2*Pz, label = 'B') - beam.addVerticalLoad(L, Pz, label = 'C') - beam.addDistLoadVertical(0, L, Pz) - beam.addDistLoadVertical(1, L*0.3, 5*Pz) - - # Plot the beam diagram - ps.plotBeamDiagram(beam) - - # Run the analysis - analysis = ps.OpenSeesAnalyzer2D(beam) - analysis.runAnalysis() - - # Plot the SFD and BMD - ps.plotShear2D(beam) - ps.plotMoment2D(beam) - - -.. toctree:: - :maxdepth: 3 - :numbered: - - rst/builder - rst/analysis - rst/diagram - rst/environment - rst/postprocess - -============= - Developed by -============= - -*Christian Slotboom* ``_. - -| M.A.Sc. Structural Engineering -| Engineer in Training - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search`