index.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="shortcut icon" href="assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-5.5.3">
  8. <title>Jypyter Sketcher</title>
  9. <link rel="stylesheet" href="assets/stylesheets/main.947af8d5.min.css">
  10. <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
  11. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  12. <style>body,input{font-family:"Roboto",-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono",SFMono-Regular,Consolas,Menlo,monospace}</style>
  13. </head>
  14. <body dir="ltr">
  15. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  16. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  17. <label class="md-overlay" for="__drawer"></label>
  18. <div data-md-component="skip">
  19. <a href="#welcome-to-jupyter-sketcher-user-guide" class="md-skip">
  20. Skip to content
  21. </a>
  22. </div>
  23. <div data-md-component="announce">
  24. </div>
  25. <header class="md-header" data-md-component="header">
  26. <nav class="md-header-nav md-grid" aria-label="Header">
  27. <a href="." title="Jypyter Sketcher" class="md-header-nav__button md-logo" aria-label="Jypyter Sketcher">
  28. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  29. </a>
  30. <label class="md-header-nav__button md-icon" for="__drawer">
  31. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  32. </label>
  33. <div class="md-header-nav__title" data-md-component="header-title">
  34. <div class="md-header-nav__ellipsis">
  35. <span class="md-header-nav__topic md-ellipsis">
  36. Jypyter Sketcher
  37. </span>
  38. <span class="md-header-nav__topic md-ellipsis">
  39. Home
  40. </span>
  41. </div>
  42. </div>
  43. <label class="md-header-nav__button md-icon" for="__search">
  44. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  45. </label>
  46. <div class="md-search" data-md-component="search" role="dialog">
  47. <label class="md-search__overlay" for="__search"></label>
  48. <div class="md-search__inner" role="search">
  49. <form class="md-search__form" name="search">
  50. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active">
  51. <label class="md-search__icon md-icon" for="__search">
  52. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  53. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  54. </label>
  55. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" data-md-component="search-reset" tabindex="-1">
  56. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  57. </button>
  58. </form>
  59. <div class="md-search__output">
  60. <div class="md-search__scrollwrap" data-md-scrollfix>
  61. <div class="md-search-result" data-md-component="search-result">
  62. <div class="md-search-result__meta">
  63. Initializing search
  64. </div>
  65. <ol class="md-search-result__list"></ol>
  66. </div>
  67. </div>
  68. </div>
  69. </div>
  70. </div>
  71. </nav>
  72. </header>
  73. <div class="md-container" data-md-component="container">
  74. <main class="md-main" data-md-component="main">
  75. <div class="md-main__inner md-grid">
  76. <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
  77. <div class="md-sidebar__scrollwrap">
  78. <div class="md-sidebar__inner">
  79. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  80. <label class="md-nav__title" for="__drawer">
  81. <a href="." title="Jypyter Sketcher" class="md-nav__button md-logo" aria-label="Jypyter Sketcher">
  82. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  83. </a>
  84. Jypyter Sketcher
  85. </label>
  86. <ul class="md-nav__list" data-md-scrollfix>
  87. <li class="md-nav__item md-nav__item--active">
  88. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  89. <a href="." title="Home" class="md-nav__link md-nav__link--active">
  90. Home
  91. </a>
  92. </li>
  93. <li class="md-nav__item">
  94. <a href="about/" title="About" class="md-nav__link">
  95. About
  96. </a>
  97. </li>
  98. <li class="md-nav__item">
  99. <a href="presentation/" title="Presentation" class="md-nav__link">
  100. Presentation
  101. </a>
  102. </li>
  103. <li class="md-nav__item">
  104. <a href="learningbyexample/" title="Learning by Example" class="md-nav__link">
  105. Learning by Example
  106. </a>
  107. </li>
  108. <li class="md-nav__item">
  109. <a href="shapereference/" title="Shapes Reference" class="md-nav__link">
  110. Shapes Reference
  111. </a>
  112. </li>
  113. <li class="md-nav__item">
  114. <a href="yamlsketcher/" title="YAML files Reference" class="md-nav__link">
  115. YAML files Reference
  116. </a>
  117. </li>
  118. <li class="md-nav__item">
  119. <a href="gallerydoc/" title="Gallery" class="md-nav__link">
  120. Gallery
  121. </a>
  122. </li>
  123. <li class="md-nav__item">
  124. <a href="resources/Gallery/" title="Gallery Notebook" class="md-nav__link">
  125. Gallery Notebook
  126. </a>
  127. </li>
  128. </ul>
  129. </nav>
  130. </div>
  131. </div>
  132. </div>
  133. <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
  134. <div class="md-sidebar__scrollwrap">
  135. <div class="md-sidebar__inner">
  136. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  137. </nav>
  138. </div>
  139. </div>
  140. </div>
  141. <div class="md-content">
  142. <article class="md-content__inner md-typeset">
  143. <h1 id="welcome-to-jupyter-sketcher-user-guide">Welcome to Jupyter Sketcher User Guide</h1>
  144. <p><a href="https://github.com/gbrault/jupytersketcher"><img alt="" src="images/github_small.png" /></a> <strong>Home Page of jupytersketcher project</strong></p>
  145. <p>Any time you need to make a sketch while solving a mechanical problem with a jupyter notebook, then PySketcher is your friend!</p>
  146. <p>A sketch capturing the "dry friction case"</p>
  147. <p><img alt="" src="images/dryfriction.svg" /></p>
  148. <p>How it is structured: the composition hierarchy</p>
  149. <p><img alt="" src="images/dotdryfriction.svg" /></p>
  150. </article>
  151. </div>
  152. </div>
  153. </main>
  154. <footer class="md-footer">
  155. <div class="md-footer-nav">
  156. <nav class="md-footer-nav__inner md-grid" aria-label="Footer">
  157. <a href="about/" title="About" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
  158. <div class="md-footer-nav__title">
  159. <div class="md-ellipsis">
  160. <span class="md-footer-nav__direction">
  161. Next
  162. </span>
  163. About
  164. </div>
  165. </div>
  166. <div class="md-footer-nav__button md-icon">
  167. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  168. </div>
  169. </a>
  170. </nav>
  171. </div>
  172. <div class="md-footer-meta md-typeset">
  173. <div class="md-footer-meta__inner md-grid">
  174. <div class="md-footer-copyright">
  175. Made with
  176. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  177. Material for MkDocs
  178. </a>
  179. </div>
  180. </div>
  181. </div>
  182. </footer>
  183. </div>
  184. <script src="assets/javascripts/vendor.c3dc8c49.min.js"></script>
  185. <script src="assets/javascripts/bundle.f9edbbd5.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents"}</script>
  186. <script>
  187. app = initialize({
  188. base: ".",
  189. features: [],
  190. search: Object.assign({
  191. worker: "assets/javascripts/worker/search.8e2cddea.min.js"
  192. }, typeof search !== "undefined" && search)
  193. })
  194. </script>
  195. <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js?config=TeX-MML-AM_CHTML"></script>
  196. </body>
  197. </html>