fork/cellxgene
1
0
Fork 0
mirror of https://github.com/chanzuckerberg/cellxgene.git synced 2026-09-23 04:08:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

cziscience landing page (#1347)

Browse Source 
* fix dead link in launch page

* first cut at landing page

* wording changes

* add additional refinements

* fixes from PR review
This commit is contained in:
Bruce Martin
2020-04-03 16:30:02 -07:00
committed by GitHub
parent de8033e551
commit 0d9f24115c
25 changed files with 446 additions and 260 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/_site/posts/hosted.html
+17 -13
View File
@@ -16,10 +16,10 @@
<meta property="og:url" content="http://localhost:4000/cellxgene/posts/hosted.html" />
<meta property="og:site_name" content="cellxgene" />
<script type="application/ld+json">
{"description":"An interactive explorer for single-cell transcriptomics data","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"http://localhost:4000/cellxgene/cellxgene-logo.png"}},"@type":"WebPage","url":"http://localhost:4000/cellxgene/posts/hosted.html","headline":"Hosting cellxgene on the web","@context":"http://schema.org"}</script>
{"description":"An interactive explorer for single-cell transcriptomics data","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"http://localhost:4000/cellxgene/cellxgene-logo.png"}},"@type":"WebPage","headline":"Hosting cellxgene on the web","url":"http://localhost:4000/cellxgene/posts/hosted.html","@context":"http://schema.org"}</script>
<!-- End Jekyll SEO tag -->
<link rel="stylesheet" href="/cellxgene/assets/css/style.css?v=d2171b9a2f9935b8b92c3103c93405d1d74ef2b3">
<link rel="stylesheet" href="/cellxgene/assets/css/style.css?v=88411ae4b44d899609d211ed2db5c41e4fba3068">
<!--[if lt IE 9]>
<script src="https://cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv.min.js"></script>
<![endif]-->
@@ -85,6 +85,10 @@
<a href="/cellxgene/posts/contact" class="btn">Contact & finding help</a><br>
<a href="/cellxgene/posts/cellxgene_cziscience_com" class="btn">cellxgene.cziscience.com</a><br>
<a href="https://github.com/chanzuckerberg/cellxgene" class="btn" target="_blank">Code</a>
</p>
@@ -103,8 +107,8 @@
<ul>
<li>Information security requires careful configuration of the host environment, including firewall, logging, etc. Please follow best practices.</li>
<li>cellxgene includes features which may be inappropriate for a hosted deployment. You may wish to use the following command line option: <code class="highlighter-rouge">--disable-diffexp</code>.</li>
<li><code class="highlighter-rouge">cellxgene launch</code> currently uses Flask’s development server, which is not recommended for hosted deployment (see the <a href="https://flask.palletsprojects.com/en/1.1.x/tutorial/deploy/#run-with-a-production-server">Flask documentation</a>)</li>
<li>cellxgene includes features which may be inappropriate for a hosted deployment. You may wish to use the following command line option: <code class="language-plaintext highlighter-rouge">--disable-diffexp</code>.</li>
<li><code class="language-plaintext highlighter-rouge">cellxgene launch</code> currently uses Flask’s development server, which is not recommended for hosted deployment (see the <a href="https://flask.palletsprojects.com/en/1.1.x/tutorial/deploy/#run-with-a-production-server">Flask documentation</a>)</li>
<li>We have no testing or official support for deployments where multiple users are accessing the same cellxgene instance.</li>
<li>Your cellxgene instance is likely to hang or crash if too many people access it at the same time, especially if they using functions that call the Python backend (such as differential expression, noted above).</li>
<li>cellxgene only supports one instance per dataset</li>
@@ -116,11 +120,11 @@
<p>The following configuration options require special consideration in any multi-user or hosted environment:</p>
<p><code class="highlighter-rouge">--disable-diffexp</code>: the differential expression computation can be resource intensive, in particular for large datasets. If many differential expression calculation requests are made in rapid sequence, it may cause the server CPU or memory resources to be exhausted, and impact the ability of other users to access data. This command line option will disable the differential expression feature, including the removal of the <code class="highlighter-rouge">Differential expression</code> button.</p>
<p><code class="language-plaintext highlighter-rouge">--disable-diffexp</code>: the differential expression computation can be resource intensive, in particular for large datasets. If many differential expression calculation requests are made in rapid sequence, it may cause the server CPU or memory resources to be exhausted, and impact the ability of other users to access data. This command line option will disable the differential expression feature, including the removal of the <code class="language-plaintext highlighter-rouge">Differential expression</code> button.</p>
<p><code class="highlighter-rouge">--experimental-annotations</code>: this feature, which is disabled by default, may not be appropriate for hosted environments. It will write to the local file system, and in extreme cases could be used to abuse (or exceed) file system capacity on the hosting server.</p>
<p><code class="language-plaintext highlighter-rouge">--disable-annotations</code>: annotations, which is enabled by default, may not be appropriate for hosted environments. It will write to the local file system, and in extreme cases could be used to abuse (or exceed) file system capacity on the hosting server. We recommend disabling this with this flag.</p>
<p><code class="highlighter-rouge">--experimental-annotations-file</code>: this specifies a single file for all end-user annotations, and is incompatible with hosted or multi-user use of cellxgene. Using it will cause loss of user annotation data (ie, the CSV file will be overwritten). If you wish to explore using the <em>experimental</em> annotations feature in a multi-user environment, please refer to the <a href="annotations">annotations documentation</a>.</p>
<p><code class="language-plaintext highlighter-rouge">--annotations-file</code>: this specifies a single file for all end-user annotations, and is incompatible with hosted or multi-user use of cellxgene. Using it will cause loss of user annotation data (ie, the CSV file will be overwritten). If you wish to explore using the annotations feature in a multi-user environment, please refer to the <a href="annotations">annotations documentation</a>, and in particular the <code class="language-plaintext highlighter-rouge">--annotations-dir</code> flag.</p>
<h2 id="community-software-projects">Community software projects</h2>
@@ -139,7 +143,7 @@
<p>Clicking on the following button will forward you to Heroku to begin the deployment process:</p>
<p><a href="https://heroku.com/deploy?template=https://github.com/chanzuckerberg/cellxgene/tree/heroku">
<p><a href="https://heroku.com/deploy?template=https://github.com/chanzuckerberg/cellxgene">
<img src="https://www.herokucdn.com/deploy/button.svg" alt="Deploy" />
</a></p>
@@ -150,20 +154,20 @@
<h3 id="default-settings">Default settings</h3>
<ul>
<li><code class="highlighter-rouge">App name</code>: the unique name for your deployment</li>
<li><code class="language-plaintext highlighter-rouge">App name</code>: the unique name for your deployment</li>
<li>This will also serve as the default URL (e.g. https://cellxgene.herokapp.com/)</li>
<li><code class="highlighter-rouge">App owner</code>: Who will own this app. Either you personally or an organization/team</li>
<li><code class="highlighter-rouge">Region</code>: Location of the server where the app will be deployed (EU or US)</li>
<li><code class="language-plaintext highlighter-rouge">App owner</code>: Who will own this app. Either you personally or an organization/team</li>
<li><code class="language-plaintext highlighter-rouge">Region</code>: Location of the server where the app will be deployed (EU or US)</li>
</ul>
<h3 id="configuration">Configuration</h3>
<ul>
<li><code class="highlighter-rouge">DATASET</code>: A <em>publicly</em> accessible URL pointing to a .h5ad file to view</li>
<li><code class="language-plaintext highlighter-rouge">DATASET</code>: A <em>publicly</em> accessible URL pointing to a .h5ad file to view</li>
<li>This defaults to pbm3k.h5ad</li>
</ul>
<p>After filling out the settings and pressing the <code class="highlighter-rouge">Deploy app</code> button Heroku will begin building your deployment. This process will take a few minutes, but once completed you will have a personal free hosted version of cellxgene!</p>
<p>After filling out the settings and pressing the <code class="language-plaintext highlighter-rouge">Deploy app</code> button Heroku will begin building your deployment. This process will take a few minutes, but once completed you will have a personal free hosted version of cellxgene!</p>
<h2 id="what-is-heroku">What is Heroku?</h2>