Skip to content

Commit

Permalink
deploy: a76abd9
Browse files Browse the repository at this point in the history
  • Loading branch information
ens-ftricomi committed Sep 28, 2023
0 parents commit a875cde
Show file tree
Hide file tree
Showing 97 changed files with 10,779 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 6ef85c61a07ec8e9f0ed07676e851c59
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/cpg.doctree
Binary file not shown.
Binary file added .doctrees/dust.doctree
Binary file not shown.
Binary file added .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/eponine.doctree
Binary file not shown.
Binary file added .doctrees/genblast.doctree
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/install.doctree
Binary file not shown.
Binary file added .doctrees/license.doctree
Binary file not shown.
Binary file added .doctrees/minimap.doctree
Binary file not shown.
Binary file added .doctrees/red.doctree
Binary file not shown.
Binary file added .doctrees/repeatmasker.doctree
Binary file not shown.
Binary file added .doctrees/scallop.doctree
Binary file not shown.
Binary file added .doctrees/star.doctree
Binary file not shown.
Binary file added .doctrees/stringtie.doctree
Binary file not shown.
Binary file added .doctrees/trf.doctree
Binary file not shown.
Binary file added .doctrees/trnascan.doctree
Binary file not shown.
Empty file added .nojekyll
Empty file.
599 changes: 599 additions & 0 deletions _modules/ensembl/tools/anno/protein_annotation/genblast.html

Large diffs are not rendered by default.

309 changes: 309 additions & 0 deletions _modules/ensembl/tools/anno/repeat_annotation/dust.html

Large diffs are not rendered by default.

271 changes: 271 additions & 0 deletions _modules/ensembl/tools/anno/repeat_annotation/red.html

Large diffs are not rendered by default.

368 changes: 368 additions & 0 deletions _modules/ensembl/tools/anno/repeat_annotation/repeatmasker.html

Large diffs are not rendered by default.

397 changes: 397 additions & 0 deletions _modules/ensembl/tools/anno/repeat_annotation/trf.html

Large diffs are not rendered by default.

364 changes: 364 additions & 0 deletions _modules/ensembl/tools/anno/simple_feature_annotation/cpg.html

Large diffs are not rendered by default.

344 changes: 344 additions & 0 deletions _modules/ensembl/tools/anno/simple_feature_annotation/eponine.html

Large diffs are not rendered by default.

398 changes: 398 additions & 0 deletions _modules/ensembl/tools/anno/snc_rna_annotation/trnascan.html

Large diffs are not rendered by default.

361 changes: 361 additions & 0 deletions _modules/ensembl/tools/anno/transcriptomic_annotation/minimap.html

Large diffs are not rendered by default.

301 changes: 301 additions & 0 deletions _modules/ensembl/tools/anno/transcriptomic_annotation/scallop.html

Large diffs are not rendered by default.

716 changes: 716 additions & 0 deletions _modules/ensembl/tools/anno/transcriptomic_annotation/star.html

Large diffs are not rendered by default.

252 changes: 252 additions & 0 deletions _modules/ensembl/tools/anno/transcriptomic_annotation/stringtie.html

Large diffs are not rendered by default.

117 changes: 117 additions & 0 deletions _modules/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; ensembl-anno 0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../_static/agogo.css?v=cc331ede" />
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=e031e9a9"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="canonical" href="https://ensembl.github.io/ensembl-anno/_modules/index.html" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
</head><body>
<div class="header-wrapper" role="banner">
<div class="header">
<div class="headertitle"><a
href="../index.html">ensembl-anno 0.1 documentation</a></div>
<div class="rel" role="navigation" aria-label="related navigation">
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |
<a href="../genindex.html" title="General Index"
accesskey="I">index</a>
</div>
</div>
</div>

<div class="content-wrapper">
<div class="content">
<div class="document">

<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<h1>All modules for which code is available</h1>
<ul><li><a href="ensembl/tools/anno/protein_annotation/genblast.html">ensembl.tools.anno.protein_annotation.genblast</a></li>
<li><a href="ensembl/tools/anno/repeat_annotation/dust.html">ensembl.tools.anno.repeat_annotation.dust</a></li>
<li><a href="ensembl/tools/anno/repeat_annotation/red.html">ensembl.tools.anno.repeat_annotation.red</a></li>
<li><a href="ensembl/tools/anno/repeat_annotation/repeatmasker.html">ensembl.tools.anno.repeat_annotation.repeatmasker</a></li>
<li><a href="ensembl/tools/anno/repeat_annotation/trf.html">ensembl.tools.anno.repeat_annotation.trf</a></li>
<li><a href="ensembl/tools/anno/simple_feature_annotation/cpg.html">ensembl.tools.anno.simple_feature_annotation.cpg</a></li>
<li><a href="ensembl/tools/anno/simple_feature_annotation/eponine.html">ensembl.tools.anno.simple_feature_annotation.eponine</a></li>
<li><a href="ensembl/tools/anno/snc_rna_annotation/trnascan.html">ensembl.tools.anno.snc_rna_annotation.trnascan</a></li>
<li><a href="ensembl/tools/anno/transcriptomic_annotation/minimap.html">ensembl.tools.anno.transcriptomic_annotation.minimap</a></li>
<li><a href="ensembl/tools/anno/transcriptomic_annotation/scallop.html">ensembl.tools.anno.transcriptomic_annotation.scallop</a></li>
<li><a href="ensembl/tools/anno/transcriptomic_annotation/star.html">ensembl.tools.anno.transcriptomic_annotation.star</a></li>
<li><a href="ensembl/tools/anno/transcriptomic_annotation/stringtie.html">ensembl.tools.anno.transcriptomic_annotation.stringtie</a></li>
</ul>

<div class="clearer"></div>
</div>
</div>
</div>
</div>
<div class="sidebar">

<h3>Table of Contents</h3>
<p class="caption" role="heading"><span class="caption-text">Index</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../install.html">API Setup and installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cpg.html">CpG Module Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dust.html">DustMasker Module Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../eponine.html">Eponine Module Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../genblast.html">Genblast Module Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../minimap.html">Minimap2 Module Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../red.html">Red Module Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../repeatmasker.html">Repeatmasker Module Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../scallop.html">Scallop Module Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../star.html">STAR Module Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../stringtie.html">Stringtie Module Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../trf.html">TRF Module Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../trnascan.html">tRNAscan-SE Module Documentation</a></li>
</ul>

<div role="search">
<h3 style="margin-top: 1.5em;">Search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
</form>
</div>

</div>
<div class="clearer"></div>
</div>
</div>

<div class="footer-wrapper">
<div class="footer">
<div class="left">
<div role="navigation" aria-label="related navigaton">
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |
<a href="../genindex.html" title="General Index"
>index</a>
</div>
<div role="note" aria-label="source link">
</div>
</div>

<div class="right">

<div class="footer" role="contentinfo">
&#169; Copyright [2016-2023] EMBL-European Bioinformatics Institute.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.1.2.
</div>
</div>
<div class="clearer"></div>
</div>
</div>

</body>
</html>
8 changes: 8 additions & 0 deletions _sources/cpg.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
CpG Module Documentation
==============================

.. automodule:: ensembl.tools.anno.simple_feature_annotation.cpg
:members:
:undoc-members:
:show-inheritance:

8 changes: 8 additions & 0 deletions _sources/dust.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
DustMasker Module Documentation
===================================

.. automodule:: ensembl.tools.anno.repeat_annotation.dust
:members:
:undoc-members:
:show-inheritance:

8 changes: 8 additions & 0 deletions _sources/eponine.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Eponine Module Documentation
==============================

.. automodule:: ensembl.tools.anno.simple_feature_annotation.eponine
:members:
:undoc-members:
:show-inheritance:

8 changes: 8 additions & 0 deletions _sources/genblast.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Genblast Module Documentation
==============================

.. automodule:: ensembl.tools.anno.protein_annotation.genblast
:members:
:undoc-members:
:show-inheritance:

58 changes: 58 additions & 0 deletions _sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
.. See the NOTICE file distributed with this work for additional information
regarding copyright ownership.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
.. ensembl-anno documentation master file, created by
sphinx-quickstart on Fri Sep 1 12:25:36 2023.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
========================================
Ensembl-anno
========================================

Anno tool kit


Contents
--------
Check out :ref:`installation <install>` section for further information on how
to install the project.

.. toctree::
:maxdepth: 1
:caption: Index

install
license

cpg
dust
eponine
genblast
minimap
red
repeatmasker
scallop
star
stringtie
trf
trnascan

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
54 changes: 54 additions & 0 deletions _sources/install.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
.. See the NOTICE file distributed with this work for additional information
regarding copyright ownership.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
API Setup and installation
===========================

Requirements
--------------

.. _install:

An Ensembl API checkout including:

- ensembl-production `ensembl-production <https://github.com/Ensembl/ensembl-production>`_.
- ensembl-analysis `ensembl-analysis <https://github.com/Ensembl/ensembl-analysis/tree/dev/hive_master>`_. (on dev/hive_master branch)
- ensembl-taxonomy `ensembl-taxonomy <https://github.com/Ensembl/ensembl-taxonomy>`_.
- ensembl-orm `ensembl-orm <https://github.com/Ensembl/ensembl-orm>`_.

Software
^^^^^^^^

#. Python 3.8+
#. Bioperl 1.6.9+

Python Modules
^^^^^^^^^^^^^^
#. argschema



Installation
------------
Directly from GitHub:

.. code-block:: none
:linenos:
git clone https://github.com/Ensembl/ensembl-analysis -b experimental/gbiab
git clone https://github.com/Ensembl/ensembl-production
git clone https://github.com/Ensembl/ensembl-hive
git clone https://github.com/Ensembl/ensembl-taxonomy
git clone https://github.com/Ensembl/ensembl-orm
Loading

0 comments on commit a875cde

Please sign in to comment.