Skip to content

Commit

Permalink
rebuild site
Browse files Browse the repository at this point in the history
  • Loading branch information
holyjak committed Aug 3, 2024
1 parent c86f08d commit 8e2caa6
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
7 changes: 4 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ <h1 data-number="1"><span class="header-section-number">1</span> Wolframite</h1>
<p>An interface between Clojure and the Wolfram Language (Supports <a href="https://www.wolfram.com/mathematica/">Mathematica</a> and <a href="https://www.wolfram.com/engine/">Wolfram Engine</a> ).</p>
<section id="status" class="level2" data-number="1.1">
<h2 data-number="1.1" class="anchored" data-anchor-id="status"><span class="header-section-number">1.1</span> Status</h2>
<p><strong>Wolframite is currently (Q2/2024) under active development again. You can <a href="https://github.com/scicloj/wolframite/discussions/17">keep track of what is happening in this discussion</a>.</strong></p>
<p><strong>Wolframite is currently (Q3/2024) under active development again. You can <a href="https://github.com/scicloj/wolframite/discussions/17">keep track of what is happening in this discussion</a>.</strong></p>
</section>
<section id="what-is-wolframite" class="level2" data-number="1.2">
<h2 data-number="1.2" class="anchored" data-anchor-id="what-is-wolframite"><span class="header-section-number">1.2</span> What is Wolframite?</h2>
Expand Down Expand Up @@ -369,7 +369,7 @@ <h3 data-number="1.3.2" class="anchored" data-anchor-id="getting-started"><span
<p>NOTE: The <code>wolframite.wolfram</code> (<code>w</code>) ns has vars for all Wolfram symbols at the time of the last release. Check <code>w/*wolfram-kernel-name*</code> for kernel type/version and run <code>(wolframite.impl.wolfram-syms.write-ns/write-ns!)</code> to generate your own wolfram ns with whatever additional symbols your Wolfram/Mathematice has, and/or with custom “aliases”.</p>
<section id="learning-wolframite" class="level4" data-number="1.3.2.1">
<h4 data-number="1.3.2.1" class="anchored" data-anchor-id="learning-wolframite"><span class="header-section-number">1.3.2.1</span> Learning Wolframite</h4>
<p>Read through and play with <a href="dev%2Fexplainer.clj">explainer.clj</a> and <a href="dev%2Fquickstart.clj">quickstart.clj</a>, which demonstrate most of Wolframite’s features and what you can do with Wolfram.</p>
<p><a href="https://scicloj.github.io/wolframite/">Visit our documentation site</a> to learn all you might want to know about using Wolframite.</p>
</section>
<section id="customizing-wolframite" class="level4" data-number="1.3.2.2">
<h4 data-number="1.3.2.2" class="anchored" data-anchor-id="customizing-wolframite"><span class="header-section-number">1.3.2.2</span> Customizing Wolframite</h4>
Expand All @@ -385,6 +385,7 @@ <h4 data-number="1.3.2.2" class="anchored" data-anchor-id="customizing-wolframit
</section>
<section id="clerk-integration" class="level3" data-number="1.3.3">
<h3 data-number="1.3.3" class="anchored" data-anchor-id="clerk-integration"><span class="header-section-number">1.3.3</span> Clerk Integration</h3>
<p>We primarily use <a href="https://scicloj.github.io/clay/">Clay</a> as our notebook tool, but there is also experimental support for <a href="https://github.com/nextjournal/clerk">Clerk</a>.</p>
<p>Example usage: (watching for changes in a folder)</p>
<pre><code>user&gt; (require '[clojuratica.tools.clerk-helper :as ch])
user&gt; (ch/clerk-watch! ["dev/notebook"])</code></pre>
Expand Down Expand Up @@ -423,7 +424,7 @@ <h4 data-number="1.5.2.1" class="anchored" data-anchor-id="documentation"><span
</section>
<section id="authors" class="level2" data-number="1.6">
<h2 data-number="1.6" class="anchored" data-anchor-id="authors"><span class="header-section-number">1.6</span> Authors</h2>
<p>The original <a href="http://clojuratica.weebly.com/">Clojuratica</a> was created by Garth Sheldon-Coulson, a graduate student at the Massachusetts Institute of Technology and Harvard Law School.</p>
<p>The original Clojuratica, Wolframite’s predecessor, was created by Garth Sheldon-Coulson, a graduate student at the Massachusetts Institute of Technology and Harvard Law School.</p>
<p>Ongoing maintenance and development over the years have been thanks to * <a href="https://github.com/chanshunli">Steve Chan</a>, * <a href="https://github.com/dfarmer">Dan Farmer</a>, * <a href="https://github.com/orb">Norman Richards</a> and others.</p>
<p>Most recently, Clojuratica has been transformed into <em>Wolframite</em> by</p>
<ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/search.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"href": "index.html#status",
"title": "Wolframite Documentation",
"section": "1.1 Status",
"text": "1.1 Status\nWolframite is currently (Q2/2024) under active development again. You can keep track of what is happening in this discussion.",
"text": "1.1 Status\nWolframite is currently (Q3/2024) under active development again. You can keep track of what is happening in this discussion.",
"crumbs": [
"<span class='chapter-number'>1</span>  <span class='chapter-title'>Wolframite</span>"
]
Expand All @@ -34,7 +34,7 @@
"href": "index.html#usage",
"title": "Wolframite Documentation",
"section": "1.3 Usage",
"text": "1.3 Usage\n\n1.3.1 Prerequisites:\n\n1.3.1.1 Clojure\nFirst, if you haven’t already, install the Clojure CLI toolchain (homebrew is a great way to do this if you’re on Mac or Linux, but you can just as easily use the installation scripts if you prefer).\n\n\n1.3.1.2 Mathematica or Wolfram Engine\nNext, obviously, you’ll need to ensure that you have Wolfram Engine or Mathematica installed and your license (free for W. E.) registered - make sure you can run these tools on their own before trying Wolframite.\nFirst of all, you need to initialize a connection to a Wolfram/Mathematica kernel, like this:\n(wolframite.core/start)\nThis should also find and load the JLink JAR included with your installation. Watch stdout for an INFO log message (via clojure.tools.logging) like:\n\n=== Adding path to classpath: /Applications/Wolfram Engine.app/Contents/Resources/Wolfram Player.app/Contents/SystemFiles/Links/JLink/JLink.jar ===\n\nHowever, sometimes Wolframite may fail to find the correct path automatically and needs your help. You can set the WOLFRAM_INSTALL_PATH environment variable or Java system property (the latter takes priority) to point to the correct location. Example:\nexport WOLFRAM_INSTALL_PATH=/opt/mathematica/13.1\n\n\n\n1.3.2 Getting started\nStart a REPL with Wolframite on the classpath, then initialize it:\n(require '[wolframite.core :as wl] \n '[wolframite.wolfram :as w]) ; Wolfram symbols as Clojure vars / fns\n;; Initialize\n(wl/start) ; =&gt; nil\n;; Use it:\n(wl/eval (w/Dot [1 2 3] [4 5 6]))\n;=&gt; 32\nMore examples\n(wl/eval (w/D (w/Power 'x 2) 'x))\n;=&gt; (* 2 x)\n(wl/eval (w/ChemicalData \"Ethanol\" \"MolarMass\"))\n;=&gt; (Quantity 46.069M (* \"Grams\" (Power \"Moles\" -1)))\n\n;; Accessing WlframAlpha\n(wl/eval (w/WolframAlpha \"How many licks does it take to get to the center of a Tootsie Pop?\")) ; BEWARE: must be online\n;=&gt; [(-&gt; [[\"Input\" 1] \"Plaintext\"] \"How many licks does it take to get to the Tootsie Roll center of a Tootsie Pop?\") (-&gt; [[\"Result\" 1] \"Plaintext\"] \"3481\\n(according to student researchers at the University of Cambridge)\")]\n\n(wl/eval (w/N w/Pi 20))\n;=&gt; 3.141592653589793238462643383279502884197169399375105820285M\n\n(wl/eval (w/Map (w/fn [x] (w/Sqrt x)) [4 16]))\n;=&gt; [2 4]\nTIP: Cursive - teach it to resolve w/fn as clojure.core/fn.\nNOTE: The wolframite.wolfram (w) ns has vars for all Wolfram symbols at the time of the last release. Check w/*wolfram-kernel-name* for kernel type/version and run (wolframite.impl.wolfram-syms.write-ns/write-ns!) to generate your own wolfram ns with whatever additional symbols your Wolfram/Mathematice has, and/or with custom “aliases”.\n\n1.3.2.1 Learning Wolframite\nRead through and play with explainer.clj and quickstart.clj, which demonstrate most of Wolframite’s features and what you can do with Wolfram.\n\n\n1.3.2.2 Customizing Wolframite\nA big advantage of Wolframite (as opposed to its earlier incarnations) is that we can now individually tailor the user experience at the level of initialization,\n(wl/start {:aliases '{** Power}})\n(wl/eval '(** 2 5)) ; =&gt; 32\n, and function call,\n(wl/start)\n(wl/eval '(** 2 5) {:aliases '{** Power}}) ; =&gt; 32\n. Use it how you want to!\nTIP: You can also get convenience vars for your aliases in wolframite.wolfram by running something like (wolframite.impl.wolfram-syms.write-ns/write-ns! &lt;path&gt; {:aliases '{** Power}}). After you load the file, you’ll be able to use (wl/eval (w/** 2 5) {:aliases '{** Power}}).\n\n\n\n1.3.3 Clerk Integration\nExample usage: (watching for changes in a folder)\nuser&gt; (require '[clojuratica.tools.clerk-helper :as ch])\nuser&gt; (ch/clerk-watch! [\"dev/notebook\"])\n\nOpen dev/notebook/quickstart.clj, make a change and save.\nOpen localhost:7777 in the browser\n\n\n\n1.3.4 How does it work?\nYou compose Wolfram expressions using the convenience functions and vars from wolframite.wolfram. These are then turned first into a symbolic representation of themselves and later into a tree of JLink Expr objects and sent to a Wolfram kernel subprocess (started by wl/start) for evaluation. The result is translated back from jlink.Expr into a Clojure form. This translation allows for some additional convenience logic, such as supporting w/* instead of Times.",
"text": "1.3 Usage\n\n1.3.1 Prerequisites:\n\n1.3.1.1 Clojure\nFirst, if you haven’t already, install the Clojure CLI toolchain (homebrew is a great way to do this if you’re on Mac or Linux, but you can just as easily use the installation scripts if you prefer).\n\n\n1.3.1.2 Mathematica or Wolfram Engine\nNext, obviously, you’ll need to ensure that you have Wolfram Engine or Mathematica installed and your license (free for W. E.) registered - make sure you can run these tools on their own before trying Wolframite.\nFirst of all, you need to initialize a connection to a Wolfram/Mathematica kernel, like this:\n(wolframite.core/start)\nThis should also find and load the JLink JAR included with your installation. Watch stdout for an INFO log message (via clojure.tools.logging) like:\n\n=== Adding path to classpath: /Applications/Wolfram Engine.app/Contents/Resources/Wolfram Player.app/Contents/SystemFiles/Links/JLink/JLink.jar ===\n\nHowever, sometimes Wolframite may fail to find the correct path automatically and needs your help. You can set the WOLFRAM_INSTALL_PATH environment variable or Java system property (the latter takes priority) to point to the correct location. Example:\nexport WOLFRAM_INSTALL_PATH=/opt/mathematica/13.1\n\n\n\n1.3.2 Getting started\nStart a REPL with Wolframite on the classpath, then initialize it:\n(require '[wolframite.core :as wl] \n '[wolframite.wolfram :as w]) ; Wolfram symbols as Clojure vars / fns\n;; Initialize\n(wl/start) ; =&gt; nil\n;; Use it:\n(wl/eval (w/Dot [1 2 3] [4 5 6]))\n;=&gt; 32\nMore examples\n(wl/eval (w/D (w/Power 'x 2) 'x))\n;=&gt; (* 2 x)\n(wl/eval (w/ChemicalData \"Ethanol\" \"MolarMass\"))\n;=&gt; (Quantity 46.069M (* \"Grams\" (Power \"Moles\" -1)))\n\n;; Accessing WlframAlpha\n(wl/eval (w/WolframAlpha \"How many licks does it take to get to the center of a Tootsie Pop?\")) ; BEWARE: must be online\n;=&gt; [(-&gt; [[\"Input\" 1] \"Plaintext\"] \"How many licks does it take to get to the Tootsie Roll center of a Tootsie Pop?\") (-&gt; [[\"Result\" 1] \"Plaintext\"] \"3481\\n(according to student researchers at the University of Cambridge)\")]\n\n(wl/eval (w/N w/Pi 20))\n;=&gt; 3.141592653589793238462643383279502884197169399375105820285M\n\n(wl/eval (w/Map (w/fn [x] (w/Sqrt x)) [4 16]))\n;=&gt; [2 4]\nTIP: Cursive - teach it to resolve w/fn as clojure.core/fn.\nNOTE: The wolframite.wolfram (w) ns has vars for all Wolfram symbols at the time of the last release. Check w/*wolfram-kernel-name* for kernel type/version and run (wolframite.impl.wolfram-syms.write-ns/write-ns!) to generate your own wolfram ns with whatever additional symbols your Wolfram/Mathematice has, and/or with custom “aliases”.\n\n1.3.2.1 Learning Wolframite\nVisit our documentation site to learn all you might want to know about using Wolframite.\n\n\n1.3.2.2 Customizing Wolframite\nA big advantage of Wolframite (as opposed to its earlier incarnations) is that we can now individually tailor the user experience at the level of initialization,\n(wl/start {:aliases '{** Power}})\n(wl/eval '(** 2 5)) ; =&gt; 32\n, and function call,\n(wl/start)\n(wl/eval '(** 2 5) {:aliases '{** Power}}) ; =&gt; 32\n. Use it how you want to!\nTIP: You can also get convenience vars for your aliases in wolframite.wolfram by running something like (wolframite.impl.wolfram-syms.write-ns/write-ns! &lt;path&gt; {:aliases '{** Power}}). After you load the file, you’ll be able to use (wl/eval (w/** 2 5) {:aliases '{** Power}}).\n\n\n\n1.3.3 Clerk Integration\nWe primarily use Clay as our notebook tool, but there is also experimental support for Clerk.\nExample usage: (watching for changes in a folder)\nuser&gt; (require '[clojuratica.tools.clerk-helper :as ch])\nuser&gt; (ch/clerk-watch! [\"dev/notebook\"])\n\nOpen dev/notebook/quickstart.clj, make a change and save.\nOpen localhost:7777 in the browser\n\n\n\n1.3.4 How does it work?\nYou compose Wolfram expressions using the convenience functions and vars from wolframite.wolfram. These are then turned first into a symbolic representation of themselves and later into a tree of JLink Expr objects and sent to a Wolfram kernel subprocess (started by wl/start) for evaluation. The result is translated back from jlink.Expr into a Clojure form. This translation allows for some additional convenience logic, such as supporting w/* instead of Times.",
"crumbs": [
"<span class='chapter-number'>1</span>  <span class='chapter-title'>Wolframite</span>"
]
Expand Down Expand Up @@ -64,7 +64,7 @@
"href": "index.html#authors",
"title": "Wolframite Documentation",
"section": "1.6 Authors",
"text": "1.6 Authors\nThe original Clojuratica was created by Garth Sheldon-Coulson, a graduate student at the Massachusetts Institute of Technology and Harvard Law School.\nOngoing maintenance and development over the years have been thanks to * Steve Chan, * Dan Farmer, * Norman Richards and others.\nMost recently, Clojuratica has been transformed into Wolframite by\n\nPawel Ceranka,\nThomas Clark and\nJakub Holý;\n\nand is now being maintained as part of the SciCloj project. Wolframite is free, open-source software, but if you would like to support our work then please cite us.\n@software{Holý_2024},\nauthor = {Holý, Jakub and Clark, Thomas and Ceranka, Pawel and Richards, Norman and Farmer, Dan and Chan, Steve and Sheldon-Coulon, Garth},\nlicense = {Mozilla Public License},\ntitle = {{Wolframite: }},\nurl = {https://github.com/scicloj/wolframite},\nversion = {1.0.0-SNAPSHOT},\nyear = {2024}",
"text": "1.6 Authors\nThe original Clojuratica, Wolframite’s predecessor, was created by Garth Sheldon-Coulson, a graduate student at the Massachusetts Institute of Technology and Harvard Law School.\nOngoing maintenance and development over the years have been thanks to * Steve Chan, * Dan Farmer, * Norman Richards and others.\nMost recently, Clojuratica has been transformed into Wolframite by\n\nPawel Ceranka,\nThomas Clark and\nJakub Holý;\n\nand is now being maintained as part of the SciCloj project. Wolframite is free, open-source software, but if you would like to support our work then please cite us.\n@software{Holý_2024},\nauthor = {Holý, Jakub and Clark, Thomas and Ceranka, Pawel and Richards, Norman and Farmer, Dan and Chan, Steve and Sheldon-Coulon, Garth},\nlicense = {Mozilla Public License},\ntitle = {{Wolframite: }},\nurl = {https://github.com/scicloj/wolframite},\nversion = {1.0.0-SNAPSHOT},\nyear = {2024}",
"crumbs": [
"<span class='chapter-number'>1</span>  <span class='chapter-title'>Wolframite</span>"
]
Expand Down

0 comments on commit 8e2caa6

Please sign in to comment.