-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(free-apis): refactor and add documentation on Anthropic usage (#78)
* docs(free-apis): refactor and add documentation on Anthropic usage * chore(npm): add missing packages and updates * feat(header): make header bar nicer * fix(manim): resolve mdx compilation errors
- Loading branch information
1 parent
318909b
commit 90de8a8
Showing
5 changed files
with
171 additions
and
85 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,39 +11,45 @@ Manim can be difficult to install so this tutorial will teach you how to run it | |
| ## Setup | ||
|
|
||
| <ol> | ||
| <li><p>The first thing you're going to need is Docker. If you don't already have docker, you can download it <a href="https://docs.docker.com/get-docker/">here</a>.</p></li> | ||
| <li><p>Pull the docker image for manim:</p> | ||
|
|
||
| ```bash | ||
| docker pull manimcommunity/manim | ||
| ``` | ||
| <li> | ||
| <p>The first thing you're going to need is Docker. If you don't already have docker, you can download it <a href="https://docs.docker.com/get-docker/">here</a>.</p> | ||
| </li> | ||
| <li> | ||
| <p>Pull the docker image for manim:</p> | ||
|
|
||
| <p>For more information, check out <a href="https://hub.docker.com/r/manimcommunity/manim">mainimcommunity/manim</a></p> | ||
| ```bash | ||
| docker pull manimcommunity/manim | ||
| ``` | ||
|
|
||
| <p>For more information, check out <a href="https://hub.docker.com/r/manimcommunity/manim">mainimcommunity/manim</a></p> | ||
| </li> | ||
| <li> | ||
| <p>There are several ways to interact with Manim. We're going to work with Jupyter Lab. For different methods check out <a href="https://hub.docker.com/r/manimcommunity/manim">this link</a>.</p> | ||
| </li> | ||
| <li><p>There are several ways to interact with Manim. We're going to work with Jupyter Lab. For different methods check out <a href="https://hub.docker.com/r/manimcommunity/manim">this link</a>.</p></li> | ||
| <li><p>First, make sure nothing is running on port 8888, then open a terminal window and run the following command to start up the manim docker container:</p> | ||
| <li> | ||
| <p>First, make sure nothing is running on port 8888, then open a terminal window and run the following command to start up the manim docker container:</p> | ||
|
|
||
| ```bash | ||
| docker run -it -p 8888:8888 manimcommunity/manim jupyter lab --ip=0.0.0.0 | ||
| ``` | ||
| ```bash | ||
| docker run -it -p 8888:8888 manimcommunity/manim jupyter lab --ip=0.0.0.0 | ||
| ``` | ||
|
|
||
| </li> | ||
| <li><p>You should see the following output:</p> | ||
| <li> | ||
| <p>You should see the following output:</p> | ||
|
|
||
| ``` | ||
| file:///manim/.local/share/jupyter/runtime/jpserver-1-open.html | ||
| ``` | ||
| file:///manim/.local/share/jupyter/runtime/jpserver-1-open.html | ||
|
|
||
| Or copy and paste one of these URLs: | ||
| Or copy and paste one of these URLs: | ||
|
|
||
| http://1a7fb2e74b32:8888/lab?token=542f72b2a4f0f8eb58089e3ab795f43c1ad3730b0500af58 | ||
| http://1a7fb2e74b32:8888/lab?token=542f72b2a4f0f8eb58089e3ab795f43c1ad3730b0500af58 | ||
|
|
||
| or http://127.0.0.1:8888/lab?token=542f72b2a4f0f8eb58089e3ab795f43c1ad3730b0500af58 | ||
| ``` | ||
| or http://127.0.0.1:8888/lab?token=542f72b2a4f0f8eb58089e3ab795f43c1ad3730b0500af58 | ||
| ``` | ||
|
|
||
| <p>Cut and Paste one of the above links in your browser. You should see the following:</p> | ||
| <p>Cut and Paste one of the above links in your browser. You should see the following:</p> | ||
|
|
||
| <img width="70%" src={require('@site/static/img/labs/misc/manim_browser.png').default} /> | ||
| <img width="70%" src={require('@site/static/img/labs/misc/manim_browser.png').default} /> | ||
|
|
||
| </li> | ||
| <li>Congratulations! You're now ready to use manim!</li> | ||
|
|
@@ -54,17 +60,19 @@ Or copy and paste one of these URLs: | |
| Let's start with a simple example: | ||
|
|
||
| <ol> | ||
| <li><p>Open a new JupyterLab notebook and import all the contents of the manim library in a cell:</p> | ||
| <li> | ||
| <p>Open a new JupyterLab notebook and import all the contents of the manim library in a cell:</p> | ||
|
|
||
| ```python | ||
| from manim import * | ||
| ```python | ||
| from manim import * | ||
|
|
||
| # To download image used in this example: | ||
| !wget https://cf-courses-data.s3.us.cloud-object-storage.appdomain.cloud/assets/logos/SN_favicon.png | ||
| ``` | ||
| # To download image used in this example: | ||
| !wget https://cf-courses-data.s3.us.cloud-object-storage.appdomain.cloud/assets/logos/SN_favicon.png | ||
| ``` | ||
| </li> | ||
|
|
||
| <li><p>Objects in manim are generally divided into three categories:</p> | ||
| <li> | ||
| <p>Objects in manim are generally divided into three categories:</p> | ||
| <ul> | ||
| <li><p>Scene</p></li> | ||
| <li><p>Mobject</p></li> | ||
|
|
@@ -88,20 +96,22 @@ class SN(Scene): | |
| ``` | ||
|
|
||
| </li> | ||
| <li><p>To run the scene, execute the following in the next code cell:</p> | ||
| <li> | ||
| <p>To run the scene, execute the following in the next code cell:</p> | ||
|
|
||
| ```python | ||
| %manim SN | ||
| ``` | ||
| ```python | ||
| %manim SN | ||
| ``` | ||
|
|
||
| <p>More generally, <code>%manim [name of class]</code> - where <code>[name of class]</code> is the name of the scene class you defined.</p> | ||
| <p>More generally, <code>%manim [name of class]</code> - where <code>[name of class]</code> is the name of the scene class you defined.</p> | ||
|
|
||
| </li> | ||
| <li><p>You should see a scene resembling the following:</p> | ||
| <li> | ||
| <p>You should see a scene resembling the following:</p> | ||
|
|
||
| <img width="70%" src={require('@site/static/img/labs/misc/manim_scene.png').default} /> | ||
| <img width="70%" src={require('@site/static/img/labs/misc/manim_scene.png').default} /> | ||
|
|
||
| <p>For more information, check out the <a href="https://docs.manim.community/en/stable/">Manim docs</a>.</p> | ||
| <p>For more information, check out the <a href="https://docs.manim.community/en/stable/">Manim docs</a>.</p> | ||
|
|
||
| </li> | ||
| </ol> | ||
|
|
@@ -112,34 +122,39 @@ __If you shut down your Docker Container you will lose your work.__ | |
| So you're going to need to download the video and JupyterLab. The lab is straightforward; let's see how to download the video: | ||
|
|
||
| <ol> | ||
| <li><p>Go to the directory <code>./media/Jupiter/</code></p></li> | ||
| <li><p>Download the video, which is the name of the class followed by an <code>@</code> and the date:</p> | ||
| <li> | ||
| <p>Go to the directory <code>./media/Jupiter/</code></p> | ||
| </li> | ||
| <li> | ||
| <p>Download the video, which is the name of the class followed by an <code>@</code> and the date:</p> | ||
|
|
||
| <p>For example, <code>SN@[email protected] more generally [name of class]@[date].mp4</code> as seen in the image below:</p> | ||
| <p>For example, <code>SN@[email protected] more generally [name of class]@[date].mp4</code> as seen in the image below:</p> | ||
|
|
||
| <img width="30%" src={require('@site/static/img/labs/misc/manim_download_video.png').default} /> | ||
| <img width="30%" src={require('@site/static/img/labs/misc/manim_download_video.png').default} /> | ||
|
|
||
| </li> | ||
| <li><p>Finally, when you close your application you must make sure the container is closed, open a terminal window and type:</p> | ||
| <li> | ||
| <p>Finally, when you close your application you must make sure the container is closed, open a terminal window and type:</p> | ||
|
|
||
| ```bash | ||
| docker ps | ||
| ``` | ||
| ```bash | ||
| docker ps | ||
| ``` | ||
|
|
||
| <p>You should see a list of your running containers, for example:</p> | ||
| <p>You should see a list of your running containers, for example:</p> | ||
|
|
||
| ``` | ||
| CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
| ``` | ||
| CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
|
|
||
| 1a7fb2e74b32 manimcommunity/manim "jupyter lab --ip=0.…" 3 days ago Up 3 days 0.0.0.0:8888->8888/tcp peaceful_kowalevski | ||
| ``` | ||
| 1a7fb2e74b32 manimcommunity/manim "jupyter lab --ip=0.…" 3 days ago Up 3 days 0.0.0.0:8888->8888/tcp peaceful_kowalevski | ||
| ``` | ||
|
|
||
| </li> | ||
| <li><p>stop the container by typing <code>docker stop [name of container]</code> for this case it would be </p> | ||
| <li> | ||
| <p>stop the container by typing <code>docker stop [name of container]</code> for this case it would be </p> | ||
|
|
||
| ```bash | ||
| docker stop peaceful_kowalevski | ||
| ``` | ||
| ```bash | ||
| docker stop peaceful_kowalevski | ||
| ``` | ||
|
|
||
| </li> | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.