Add blog post about using Python for photonics

PreFab-Photonics · Oct 10, 2024 · 290092e · 290092e
1 parent 48ad4fc
commit 290092e
Show file tree

Hide file tree

Showing 7 changed files with 338 additions and 2 deletions.
diff --git a/docs/assets/blog_cards/python-for-photonics.png b/docs/assets/blog_cards/python-for-photonics.png
diff --git a/docs/assets/logo.png b/docs/assets/logo.png
diff --git a/docs/assets/promo_c.png b/docs/assets/promo_c.png
diff --git a/docs/assets/promo_p.png b/docs/assets/promo_p.png
diff --git a/docs/blog/python-for-photonics.md b/docs/blog/python-for-photonics.md
diff --git a/docs/index.md b/docs/index.md
@@ -30,7 +30,8 @@ For those who wish to make changes to the source code for their own development
 
 ```sh
 git clone https://github.com/PreFab-Photonics/PreFab.git
-pip install -e prefab
+cd PreFab
+pip install -e .
 ```
 
 ## Authenticate PreFab token
@@ -48,6 +49,8 @@ See the following guides to get started with making your first predictions and c
 1. [Making a prediction](examples/1_prediction.ipynb)
 2. [Making a correction](examples/2_correction.ipynb)
 
+If you are new to Python, we recommend starting with the [Python for Photonics](blog/python-for-photonics.md) blog post.
+
 !!! tip "Performance and usage"
 
     PreFab models are served via a serverless [cloud platform](https://modal.com/). Please note:

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -13,7 +13,8 @@ nav:
     - Working with sidewall angles: examples/3_sidewall_angle.ipynb
     - SEM generation: examples/4_SEM_generation.ipynb
   - Blog:
-      - PreFab v1.1.0: blog/PreFab-v1.1.0.ipynb
+    - Python for Photonics: blog/python-for-photonics.md
+    - PreFab v1.1.0: blog/PreFab-v1.1.0.ipynb
   - Reference:
       - Compare: reference/compare.md
       - Device: reference/device.md