Generate random interfaces for GIFs

other/generate_gifs/gif_processing.ipynb

@@ -184,7 +184,7 @@
    "metadata": {},
    "cell_type": "code",
    "source": [
-    "from other.media_generation.utils.font_manager import FontManager\n",
+    "from other.generate_gifs.utils.font_manager import FontManager\n",
     "\n",
     "# Initialize font manager and list available fonts\n",
     "font_manager = FontManager()\n",
@@ -243,7 +243,7 @@
    "metadata": {},
    "cell_type": "code",
    "source": [
-    "from other.media_generation.utils.gif_processor import GIFProcessor\n",
+    "from other.generate_gifs.utils.gif_processor import GIFProcessor\n",
     "\n",
     "\n",
     "def process_all_gifs():\n",

other/media_generation/README.md

@@ -0,0 +1,38 @@
+# GIFs generation with Materials visualization
+
+## 1. Setup materials
+
+1.1. Generate materials in Mat3ra JSON format with [Materials Designer](https://materials-designer.mat3ra.com/) or use a script.
+
+1.2. Place materials JSON files in the `uploads` directory.
+
+1.3. Name them with a short name that will appear at bottom left of GIF.
+
+Alternatively, you can use `create_materials` notebook that has functionality for random generation of some types of materials. Since it's random, verification of the generated materials is necessary.
+
+## 2. Start wave.js
+
+2.1. Run wave.js (from PR: https://github.com/Exabyte-io/wave.js/pull/165) locally (default port 3002 -- used in notebooks).
+
+Or keep URL of the Netlify deployment in the notebook.
+
+## 3. Record material GIFs
+
+3.1. Run `record_gifs_with_wave.ipynb` to generate GIFs.
+
+This notebook will generate GIFs for all JSON materials in the `input` directory and save them in the `output` directory.
+
+3.2. Wait until the GIFs are downloaded. They will appear at the top level of the repo, because we can't control the saving directory. But the next notebook will automatically move them to the `output` directory.
+
+## 4. Add overlays and generate final GIFs
+
+4.1. Store any media files (e.g. images, videos) you want to overlay on the GIFs in the `assets` directory.
+
+4.2. Run `gif_processing_multiple.ipynb` to add overlays and generate final GIFs.
+
+This notebook will move the GIFs from the top level to the `output` directory, removing any duplications (judging by the file name), and add overlays with the material names.
+
+
+## Single GIF processing
+
+If you created a GIF with Materials Designer manually, you can use the `gif_processing_single.ipynb` notebook to add overlays and generate the final GIF.