index.html 17.2 KB

<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Welcome in the AstroMeCCA software documentation &#8212; Mount Control Software 1.0.0 documentation</title>
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
    <link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
    
    <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/doctools.js"></script>
    
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="First steps with the Mount Control Software" href="using_mount_control_software.html" /> 
  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="using_mount_control_software.html" title="First steps with the Mount Control Software"
             accesskey="N">next</a> |</li>
        <li class="nav-item nav-item-0"><a href="#">Mount Control Software 1.0.0 documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Welcome in the AstroMeCCA software documentation</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="welcome-in-the-astromecca-software-documentation">
<h1>Welcome in the AstroMeCCA software documentation<a class="headerlink" href="#welcome-in-the-astromecca-software-documentation" title="Permalink to this headline">¶</a></h1>
<a class="reference internal image-reference" href="_images/cropped-logo-astromecca.jpg"><img alt="_images/cropped-logo-astromecca.jpg" class="align-center" src="_images/cropped-logo-astromecca.jpg" style="height: 300px;" /></a>
<table class="docutils align-default">
<colgroup>
<col style="width: 44%" />
<col style="width: 56%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><div class="line-block">
<div class="line">107, Bis route de Servies</div>
<div class="line">En Raynaud</div>
<div class="line">81570 Cuq les Vielmur</div>
<div class="line">FRANCE</div>
</div>
</td>
<td><div class="line-block">
<div class="line">Director: Antoine Cailleau</div>
<div class="line"><a class="reference external" href="mailto:antoine&#46;cailleau&#37;&#52;&#48;astromecca&#46;fr">antoine<span>&#46;</span>cailleau<span>&#64;</span>astromecca<span>&#46;</span>fr</a></div>
<div class="line">+33 6 64 45 73 25</div>
<div class="line"><a class="reference external" href="http://astromecca.fr/">http://astromecca.fr/</a></div>
</div>
</td>
</tr>
</tbody>
</table>
<div class="figure align-center" id="id1">
<a class="reference internal image-reference" href="_images/rapido2_v2a.jpg"><img alt="_images/rapido2_v2a.jpg" src="_images/rapido2_v2a.jpg" style="height: 300px;" /></a>
<p class="caption"><span class="caption-number">Fig. 1 </span><span class="caption-text">A German TM 350 AtroMeCCA mount equiped by a reflector 300mm telescope and a refractor 60mm telescope.</span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
</div>
<div class="section" id="using-the-mount-control-software">
<h2>1. Using the Mount Control Software<a class="headerlink" href="#using-the-mount-control-software" title="Permalink to this headline">¶</a></h2>
<p>Describes the basic use of the Mount Control Software and
how to use its pad to slew the mount towards sky objects.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="using_mount_control_software.html">First steps with the Mount Control Software</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using_mount_control_software.html#check-if-mcs-is-running-as-service">Check if MCS is running as service</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="using_mount_control_software.html#use-the-pad-of-the-mount-control-software">Use the pad of the Mount Control Software</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using_mount_control_software.html#drive-the-mount">Drive the mount</a></li>
<li class="toctree-l2"><a class="reference internal" href="using_mount_control_software.html#help-for-polar-aligment">Help for polar aligment</a></li>
<li class="toctree-l2"><a class="reference internal" href="using_mount_control_software.html#mount-configuration">Mount configuration</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="using_mount_control_software.html#mount-control-software-for-experimented-users">Mount Control Software for experimented users</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using_mount_control_software.html#change-the-mcs-configuration-of-the-command-line">Change the MCS configuration of the command line</a></li>
<li class="toctree-l2"><a class="reference internal" href="using_mount_control_software.html#change-the-mcs-configuration-for-running-as-service">Change the MCS configuration for running as service</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="communication-protocols-for-astromecca">
<h2>2. Communication protocols for AstroMecCA<a class="headerlink" href="#communication-protocols-for-astromecca" title="Permalink to this headline">¶</a></h2>
<p>Describes the communication protocols to commuunicate between a client software (ASCOM, INDI or any external software) and an astromecca server.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="communication_langage_protocol.html">Communication protocols for astromecca mounts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="communication_langage_protocol.html#serial-port-and-lx200-protocol">1. Serial port and LX200 protocol</a></li>
<li class="toctree-l2"><a class="reference internal" href="communication_langage_protocol.html#ethernet-tcp-port-and-mcs-protocol">2. Ethernet TCP port and MCS protocol</a></li>
<li class="toctree-l2"><a class="reference internal" href="communication_langage_protocol.html#the-mcs-langage-protocol">3. The MCS langage protocol</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="user-guide-to-program-with-mount-python-classes">
<h2>3. User guide to program with mount Python classes<a class="headerlink" href="#user-guide-to-program-with-mount-python-classes" title="Permalink to this headline">¶</a></h2>
<p>Describe how to instanciate mount classes to use them in a personal Python code.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="using_mount_classes.html">User guide to program with mount Python classes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using_mount_classes.html#classes-and-attributes">1. Classes and attributes</a></li>
<li class="toctree-l2"><a class="reference internal" href="using_mount_classes.html#examples-of-python-codes-to-instanciate-the-mount">2. Examples of Python codes to instanciate the mount</a></li>
<li class="toctree-l2"><a class="reference internal" href="using_mount_classes.html#examples-of-python-codes-to-drive-the-mount">3. Examples of Python codes to drive the mount</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="user-guide-to-program-with-celme-python-classes">
<h2>4. User guide to program with celme Python classes<a class="headerlink" href="#user-guide-to-program-with-celme-python-classes" title="Permalink to this headline">¶</a></h2>
<p>Describe how to instanciate celme classes to use them in a personal Python code. Celme is a tool used by mount classes.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="using_celme_classes.html">User guide to program with celme Python classes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="using_celme_classes.html#context">1. Context</a></li>
<li class="toctree-l2"><a class="reference internal" href="using_celme_classes.html#python-classes-provided-by-celme">2. Python classes provided by celme</a></li>
<li class="toctree-l2"><a class="reference internal" href="using_celme_classes.html#using-the-python-module-celme-for-angles">3. Using the Python module celme for angles</a><ul>
<li class="toctree-l3"><a class="reference internal" href="using_celme_classes.html#simple-example-to-convert-angles">3.1. Simple example to convert angles</a></li>
<li class="toctree-l3"><a class="reference internal" href="using_celme_classes.html#operation-with-angles">3.2. Operation with angles</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="using_celme_classes.html#using-the-python-module-celme-for-dates">4. Using the Python module celme for dates</a><ul>
<li class="toctree-l3"><a class="reference internal" href="using_celme_classes.html#simple-example-to-convert-dates">4.1. Simple example to convert dates</a></li>
<li class="toctree-l3"><a class="reference internal" href="using_celme_classes.html#operation-with-dates">4.2. Operation with dates</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="using_celme_classes.html#using-the-python-module-celme-for-ephemeris">5. Using the Python module celme for ephemeris</a><ul>
<li class="toctree-l3"><a class="reference internal" href="using_celme_classes.html#simple-example-to-compute-sun-coordinates">5.1. Simple example to compute Sun coordinates</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="using_celme_classes.html#angle-formats">6. Angle formats</a></li>
<li class="toctree-l2"><a class="reference internal" href="using_celme_classes.html#date-formats">7. Date formats</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="class-and-method-documentation">
<h2>5. Class and method documentation<a class="headerlink" href="#class-and-method-documentation" title="Permalink to this headline">¶</a></h2>
<p>For developers of Python code in mount classes.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="generate_documentation.html">Generate this documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generate_documentation.html#installation-of-sphinx-and-pyreverse">Installation of Sphinx and Pyreverse</a></li>
<li class="toctree-l2"><a class="reference internal" href="generate_documentation.html#generate-the-documentation">Generate the documentation</a></li>
</ul>
</li>
</ul>
</div>
<p>The classes of Mounts for astronomy.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="autodoc_mount.html">Classes for driving mounts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="definition_rotation.html">Definition of the rotation system of a mount</a><ul>
<li class="toctree-l3"><a class="reference internal" href="definition_rotation.html#relation-between-celestial-coordinates-and-the-encoders-of-the-mount">Relation between celestial coordinates and the encoders of the mount</a></li>
<li class="toctree-l3"><a class="reference internal" href="definition_rotation.html#definition-of-the-angles-rotb-rotp">Definition of the angles rotb, rotp</a></li>
<li class="toctree-l3"><a class="reference internal" href="definition_rotation.html#relations-between-rotb-rotp-and-celb-celp">Relations between (rotb, rotp) and (celb, celp)</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="autodoc_mount.html#module-0">Module mountastro</a><ul>
<li class="toctree-l3"><a class="reference internal" href="autodoc_mount.html#module-mountastro.mountastro">mountastro.mountastro</a></li>
<li class="toctree-l3"><a class="reference internal" href="autodoc_mount.html#module-mountastro.mountaxis">mountastro.mountaxis</a></li>
<li class="toctree-l3"><a class="reference internal" href="autodoc_mount.html#module-mountastro.mountchannel">mountastro.mountchannel</a></li>
<li class="toctree-l3"><a class="reference internal" href="autodoc_mount.html#module-mountastro.mounttools">mountastro.mounttools</a></li>
<li class="toctree-l3"><a class="reference internal" href="autodoc_mount.html#module-mountastro.mountpad">mountastro.mountpad</a></li>
<li class="toctree-l3"><a class="reference internal" href="autodoc_mount.html#module-mountastro.mountlog">mountastro.mountlog</a></li>
<li class="toctree-l3"><a class="reference internal" href="autodoc_mount.html#module-mountastro.mountastro_astromecca">mountastro.mountastro_astromecca</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="autodoc_celme.html">Classes for celestial mechanics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="autodoc_celme.html#module-0">Module celme</a><ul>
<li class="toctree-l3"><a class="reference internal" href="autodoc_celme.html#module-celme.dates">celme.dates</a></li>
<li class="toctree-l3"><a class="reference internal" href="autodoc_celme.html#module-celme.durations">celme.durations</a></li>
<li class="toctree-l3"><a class="reference internal" href="autodoc_celme.html#module-celme.angles">celme.angles</a></li>
<li class="toctree-l3"><a class="reference internal" href="autodoc_celme.html#module-celme.coords">celme.coords</a></li>
<li class="toctree-l3"><a class="reference internal" href="autodoc_celme.html#module-celme.horizon">celme.horizons</a></li>
<li class="toctree-l3"><a class="reference internal" href="autodoc_celme.html#module-celme.atmosphere">celme.atmosphere</a></li>
<li class="toctree-l3"><a class="reference internal" href="autodoc_celme.html#module-celme.home">celme.home</a></li>
<li class="toctree-l3"><a class="reference internal" href="autodoc_celme.html#module-celme.site">celme.site</a></li>
<li class="toctree-l3"><a class="reference internal" href="autodoc_celme.html#module-celme.mechanics">celme.mechanics</a></li>
<li class="toctree-l3"><a class="reference internal" href="autodoc_celme.html#module-celme.targets">celme.targets</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="#">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Welcome in the AstroMeCCA software documentation</a><ul>
<li><a class="reference internal" href="#using-the-mount-control-software">1. Using the Mount Control Software</a></li>
<li><a class="reference internal" href="#communication-protocols-for-astromecca">2. Communication protocols for AstroMecCA</a></li>
<li><a class="reference internal" href="#user-guide-to-program-with-mount-python-classes">3. User guide to program with mount Python classes</a></li>
<li><a class="reference internal" href="#user-guide-to-program-with-celme-python-classes">4. User guide to program with celme Python classes</a></li>
<li><a class="reference internal" href="#class-and-method-documentation">5. Class and method documentation</a><ul>
</ul>
</li>
</ul>
</li>
</ul>

  <h4>Next topic</h4>
  <p class="topless"><a href="using_mount_control_software.html"
                        title="next chapter">First steps with the Mount Control Software</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/index.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="using_mount_control_software.html" title="First steps with the Mount Control Software"
             >next</a> |</li>
        <li class="nav-item nav-item-0"><a href="#">Mount Control Software 1.0.0 documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Welcome in the AstroMeCCA software documentation</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2021, astromecca.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.0.
    </div>
  </body>
</html>