Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yla committed Oct 31, 2023
1 parent df3f654 commit e468b6f
Show file tree
Hide file tree
Showing 30 changed files with 709 additions and 567 deletions.
File renamed without changes
Binary file removed _images/logo1.png
Binary file not shown.
3 changes: 0 additions & 3 deletions _sources/chapter_8_publications/p_intro.md

This file was deleted.

112 changes: 112 additions & 0 deletions _sources/chapter_getstart/getstart_intro_nopublish.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
{
"cells": [
{
"cell_type": "markdown",
"id": "6bc2cadf",
"metadata": {},
"source": [
"# Get Started\n",
"\n",
"\n",
"$_{Yongtao}$ $_{Liu,}$ $_{liuy3@ornl.gov}$\n",
"\n",
"$_{July}$ $_{2023}$"
]
},
{
"cell_type": "markdown",
"id": "fbfb10f3",
"metadata": {},
"source": [
"## Install\n",
"\n",
"This introduction shows how to install or import AEcroscopy"
]
},
{
"cell_type": "markdown",
"id": "682d0459",
"metadata": {},
"source": [
"```{Attention}\n",
"AEcroscopy is a Python package for seamless communications with Application Program Interface (API), PyAE and/or PyScanner. PyAE and PyScanner are crafted using ActiveX controls for Windows operating system. Therefore, for compatibility, we recommand use AEcroscopy in your Windows environment.\n",
"``` "
]
},
{
"cell_type": "markdown",
"id": "39c604d7",
"metadata": {},
"source": [
"### Import AEcroscopy Acquisition"
]
},
{
"cell_type": "markdown",
"id": "574545a4",
"metadata": {},
"source": [
"The following code will import AEcroscopy Acquistion class"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "ddea078a",
"metadata": {},
"outputs": [],
"source": [
"from Acquisition_v_xx import Acquistion"
]
},
{
"cell_type": "markdown",
"id": "44aeccf1",
"metadata": {},
"source": [
"You can download AEcroscopy from source."
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "227be862",
"metadata": {},
"outputs": [],
"source": [
"git clone https://github.com/yongtaoliu/aecroscopy.pyae"
]
},
{
"cell_type": "markdown",
"id": "a70c42d7",
"metadata": {},
"source": [
"```{admonition} Trouble\n",
"If you have trouble, please reach out on the forum or via email.\n",
"```"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.9"
}
},
"nbformat": 4,
"nbformat_minor": 5
}
6 changes: 2 additions & 4 deletions _sources/chapter_welcome/welcome_intro.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# Welcome to AEcroscopy

Welcom to AEcroscopy! With this site, we aim to provide an introduction and tutorial to use AEcroscopy for automated and autonomous microscopy experiments and data processing, you will learn how to translate experiment plans to Python programs that can be executed in a microscope.
Welcom to AEcroscoPy! With this site, we aim to provide an introduction and tutorial to use AEcroscoPy for automated and autonomous microscopy experiments and data processing, you will learn how to translate experiment plans to Python programs that can be executed in a microscope.

```{image} ../images/logo.png
:alt: logo
:class: bg-primary mb-1
```{image} ../images/LOGO.png
:width: 400px
:align: center
```
Expand Down
21 changes: 0 additions & 21 deletions _sources/intro.md

This file was deleted.

4 changes: 2 additions & 2 deletions _sources/welcome_intro.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"id": "1256f201",
"metadata": {},
"source": [
"Welcom to AEcroscopy! With this site, we aim to provide an introduction and tutorial to use AEcroscopy for automated and autonomous microscopy experiments and data processing. "
"Welcom to AEcroscoPy! With this site, we aim to provide an introduction and tutorial to use AEcroscopy for automated and autonomous microscopy experiments and data processing. "
]
},
{
Expand All @@ -34,7 +34,7 @@
"source": [
"Automated and autonomous experiments have become popular in various fields, such as drug discovery, spae epxloration, environmental monitoring, and materials science. Automated experiments leverage technology and machinery to perform tasks automatically to improve efficiency and precision, autonomous experiments is a step further by integrating artifical intelligence (AI) and machine learning (ML) for data analysis, decision-making, optimization, and adaption. A program package and application program interface (API) can empower researchers to build sophisticated autonomous systems to conduct experiments with a high degree of autonomy and efficiency by providing handy infrastructure and tools for seamless intergration, efficience hardware control, AI-based decision-making, and real-time adpation in experiments. \n",
"\n",
"AEcroscopy is a Python package that integrates with our self-developed API PyAE and PyScanner, aiming to revolutionizing microscopy measurements. AEcroscopy enables easy implementation of experiments formulated with Python program, allows users to orchestrate complex experiments, design workflows, and gather data more efficiently. Furthermore, AEcroscopy allows users to integrate ML models into the operating experiment, harnessing the power of AI for real-time data analysis and decision-making. This will enable rapid iterations in experiment and largely accelerate scientific discovery in microscopy experiments.\n",
"AEcroscoPy is a Python package that integrates with our self-developed API PyAE and PyScanner, aiming to revolutionizing microscopy measurements. AEcroscoPy enables easy implementation of experiments formulated with Python program, allows users to orchestrate complex experiments, design workflows, and gather data more efficiently. Furthermore, AEcroscopy allows users to integrate ML models into the operating experiment, harnessing the power of AI for real-time data analysis and decision-making. This will enable rapid iterations in experiment and largely accelerate scientific discovery in microscopy experiments.\n",
"\n",
"With this site, you will discover the potential of AEcroscopy and experience the future of microscopy experimentation."
]
Expand Down
6 changes: 3 additions & 3 deletions chapter_1_experiment/aecroscopy_command_intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="About Data Process" href="../chapter_2_data_processing/dp_intro.html" />
<link rel="prev" title="Get Started" href="../chapter_getstart/getstart_intro.html" />
<link rel="prev" title="Get Started" href="../chapter_getstart/getstart_intro_nopublish.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
Expand Down Expand Up @@ -165,7 +165,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Get Started</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro.html">Get Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro_nopublish.html">Get Started</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Experiment</span></p>
<ul class="current nav bd-sidenav">
Expand Down Expand Up @@ -1188,7 +1188,7 @@ <h3>FPGA Driven Line by Line Raster Scan<a class="headerlink" href="#fpga-driven
<div class="footer-article-item"><!-- Previous / next buttons -->
<div class="prev-next-area">
<a class="left-prev"
href="../chapter_getstart/getstart_intro.html"
href="../chapter_getstart/getstart_intro_nopublish.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
Expand Down
4 changes: 2 additions & 2 deletions chapter_2_data_processing/dp_intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Get Started</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro.html">Get Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro_nopublish.html">Get Started</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Experiment</span></p>
<ul class="nav bd-sidenav">
Expand Down Expand Up @@ -203,7 +203,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Publications</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/p_intro.html">About Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/pubs.html">Publications</a></li>
</ul>

</div>
Expand Down
4 changes: 2 additions & 2 deletions chapter_3_edge_computing/ec_intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Get Started</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro.html">Get Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro_nopublish.html">Get Started</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Experiment</span></p>
<ul class="nav bd-sidenav">
Expand Down Expand Up @@ -203,7 +203,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Publications</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/p_intro.html">About Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/pubs.html">Publications</a></li>
</ul>

</div>
Expand Down
4 changes: 2 additions & 2 deletions chapter_4_llm_in_aecroscopy/llm_intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Get Started</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro.html">Get Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro_nopublish.html">Get Started</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Experiment</span></p>
<ul class="nav bd-sidenav">
Expand Down Expand Up @@ -203,7 +203,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Publications</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/p_intro.html">About Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/pubs.html">Publications</a></li>
</ul>

</div>
Expand Down
4 changes: 2 additions & 2 deletions chapter_5_automated_experimentation/ht_domain_writing.html
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Get Started</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro.html">Get Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro_nopublish.html">Get Started</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Experiment</span></p>
<ul class="nav bd-sidenav">
Expand Down Expand Up @@ -205,7 +205,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Publications</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/p_intro.html">About Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/pubs.html">Publications</a></li>
</ul>

</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Get Started</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro.html">Get Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro_nopublish.html">Get Started</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Experiment</span></p>
<ul class="nav bd-sidenav">
Expand Down Expand Up @@ -203,7 +203,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Publications</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/p_intro.html">About Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/pubs.html">Publications</a></li>
</ul>

</div>
Expand Down
4 changes: 2 additions & 2 deletions chapter_5_automated_experimentation/ht_intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Get Started</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro.html">Get Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro_nopublish.html">Get Started</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Experiment</span></p>
<ul class="nav bd-sidenav">
Expand Down Expand Up @@ -205,7 +205,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Publications</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/p_intro.html">About Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/pubs.html">Publications</a></li>
</ul>

</div>
Expand Down
4 changes: 2 additions & 2 deletions chapter_5_automated_experimentation/ht_wall_thickness.html
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Get Started</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro.html">Get Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro_nopublish.html">Get Started</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Experiment</span></p>
<ul class="nav bd-sidenav">
Expand Down Expand Up @@ -205,7 +205,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Publications</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/p_intro.html">About Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/pubs.html">Publications</a></li>
</ul>

</div>
Expand Down
4 changes: 2 additions & 2 deletions chapter_6_autonomous_experimentation/ae_intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Get Started</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro.html">Get Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro_nopublish.html">Get Started</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Experiment</span></p>
<ul class="nav bd-sidenav">
Expand Down Expand Up @@ -205,7 +205,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Publications</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/p_intro.html">About Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/pubs.html">Publications</a></li>
</ul>

</div>
Expand Down
4 changes: 2 additions & 2 deletions chapter_6_autonomous_experimentation/ml_dkl.html
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Get Started</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro.html">Get Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro_nopublish.html">Get Started</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Experiment</span></p>
<ul class="nav bd-sidenav">
Expand Down Expand Up @@ -205,7 +205,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Publications</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/p_intro.html">About Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/pubs.html">Publications</a></li>
</ul>

</div>
Expand Down
4 changes: 2 additions & 2 deletions chapter_6_autonomous_experimentation/ml_hypoal.html
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Get Started</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro.html">Get Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_getstart/getstart_intro_nopublish.html">Get Started</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Experiment</span></p>
<ul class="nav bd-sidenav">
Expand Down Expand Up @@ -205,7 +205,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Publications</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/p_intro.html">About Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../chapter_8_publications/pubs.html">Publications</a></li>
</ul>

</div>
Expand Down
Loading

0 comments on commit e468b6f

Please sign in to comment.