diff --git a/docs/_toc.yml b/docs/_toc.yml index 2239224521696c953c800625651ecc2ca9f9f218..b8adb2aa36f40ba5d32837b3c439c1b3e51efb4a 100644 --- a/docs/_toc.yml +++ b/docs/_toc.yml @@ -1,6 +1,18 @@ format: jb-book root: intro parts: +- caption: TutorialsMuysc + chapters: + - file: start/your-first-book + sections: + - file: starting/install + - file: starting/coordinates + - file: start/build + - file: start/new-file + - file: start/publish + - file: start/example-book + - file: tutorials/references + - caption: Tutorials chapters: - file: start/your-first-book diff --git a/docs/images/FujiStructure.jpg b/docs/images/FujiStructure.jpg new file mode 100644 index 0000000000000000000000000000000000000000..33b91446d2d7cbd120de57518df8dcf1bebacb63 Binary files /dev/null and b/docs/images/FujiStructure.jpg differ diff --git a/docs/images/MachinStructure.jpg b/docs/images/MachinStructure.jpg new file mode 100644 index 0000000000000000000000000000000000000000..eed684c09fb32aa15df7a34b6a9b8e3c9eb209c0 Binary files /dev/null and b/docs/images/MachinStructure.jpg differ diff --git a/docs/images/Modules.jpg b/docs/images/Modules.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7dc057bc5082dd3b1fd1571986ac789929b43407 Binary files /dev/null and b/docs/images/Modules.jpg differ diff --git a/docs/images/cerroGoogle.PNG b/docs/images/cerroGoogle.PNG new file mode 100644 index 0000000000000000000000000000000000000000..632682158fefe0a00aa17e56512f425a7c889942 Binary files /dev/null and b/docs/images/cerroGoogle.PNG differ diff --git a/docs/modules/First.md b/docs/modules/First.md new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/docs/starting/coordinates.md b/docs/starting/coordinates.md new file mode 100644 index 0000000000000000000000000000000000000000..fb344f7a0bfa9db9d78c8480eb9488e59e2f0f7b --- /dev/null +++ b/docs/starting/coordinates.md @@ -0,0 +1,48 @@ +# First map with MUYSC + +In MUYSC, we utilize decimal coordinates to accurately locate objects, and for enhanced precision in studying specific zones, we recommend using Google Earth. + + +```md + +``` +The initial step involves creating a polygon surrounding the object of interest. Subsequently, place two points along a diagonal of the polygon, and input the obtained geographic coordinates into the MUYSC format. This will result in a quadrilateral representing the study area. + +:::{note} +If you put the **coordinates** in other format it will show a different zone than the desired. +::: + +Running this code you will visualize the structure of Cerro MachÃn: + + +:::{code-cell} +# CERRO MACHÃN ESTRUCTURA +regionPoints = [4.466944, 4.500833, -75.404720, -75.372694, "CERRO MACHÃN"] +a = MuyscImprove.Mute(regionPoints,80,srtm1_data, "Greens") +a.elevation() +a.plot_structure() +::: + + +The following illustrates an example of how MUYSC can display the geological structure: + +```md + +``` + +Now let's see other part in the world + +:::{code-cell} +# MONTE FUJI ESTRUCTURA +regionPoints = [35.398710, 35.327432, 138.799493, 138.683672, "MONTE FUJI"] +a = MuyscImprove.Mute(regionPoints,80,srtm1_data, "Greens") +a.elevation() +a.plot_structure() +::: + + +The following illustrates an example of how MUYSC can display the geological structure: + +```md + +``` \ No newline at end of file diff --git a/docs/starting/install.md b/docs/starting/install.md new file mode 100644 index 0000000000000000000000000000000000000000..37cd7e336cc8b9289a324cb2d9f68639a47a8fc5 --- /dev/null +++ b/docs/starting/install.md @@ -0,0 +1,46 @@ +--- +jupytext: + formats: md:myst + text_representation: + extension: .md + format_name: myst + format_version: 0.12 + jupytext_version: 1.6.0 +kernelspec: + display_name: Python 3 + language: python + name: python3 +--- + +# Overview + +MUYSC, a simulation framework for Muography. Here's a brief summary of the primary elements and stages involved in the creation of a Jupyter Book. For a more comprehensive understanding, refer to the additional pages in this guide. + +(start:install)= +## Install Jupyter Book + +You can install MUYSC [via `pip`](https://pip.pypa.io/en/stable/): + +```bash +pip install MUYSC +``` + +This will install everything you need to do on end-to-end Muography Simulation. + + +## Structure + +MUYSC, as a simulation software for muography studies, benefits significantly from a modular approach in its design and construction. One of the main reasons for building MUYSC as a modular software is the flexibility this offers in developing and adapting to the changing needs of muography research. + +```console +$ MUYSC structure +modules/ +├── DownloadTopography +├── RayTracing +├── Muography +└── Telescope parameters +``` + +In MUYSC you only need to know the geographic coordinates of the study object. in the section building your first map you will find the way of we study objects with google earth. + +