Skip to content

Commit

Permalink
deploy updates
Browse files Browse the repository at this point in the history
  • Loading branch information
novoselt committed Jun 16, 2024
1 parent e9553a8 commit d8df161
Show file tree
Hide file tree
Showing 33 changed files with 346 additions and 69 deletions.
2 changes: 2 additions & 0 deletions _sources/compute_server.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ A compute server in CoCalc brings you closer to your dreams using an extremely p
- Get daily statements by email


.. _colab_example:

Examples of Compute Server Uses
-------------------------------

Expand Down
2 changes: 2 additions & 0 deletions _sources/howto/install-python-lib.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Related: :doc:`custom-jupyter-kernel`, :doc:`jupyter-extension` and :doc:`instal
:local:
:depth: 3

.. _install-request:

Install requests
===================

Expand Down
52 changes: 19 additions & 33 deletions _sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,33 +7,29 @@ What is CoCalc?
Welcome
#######################

Hello, and welcome to `CoCalc`_.
CoCalc is a virtual online workspace for calculations, research, collaboration and authoring documents.
Your web browser is all you need to escape the confined space of your desktop and move to the cloud.
This guide explains the features of CoCalc in depth and shows how you can use them productively.

The main building blocks for working on CoCalc are :doc:`Projects <project>`.
Create one or more projects in order to partition your work into separate *workspaces*.
Each project consists of files, accessible only to you and your
:ref:`collaborators <add-collaborators>`.
Hello, and welcome to `CoCalc`_,
a virtual online platform for calculations, research, collaboration and authoring documents!

The main building blocks for working in CoCalc are :doc:`Projects <project>` - separate *workspaces*
consisting of files accessible only to you and your
:ref:`collaborators <add-collaborators>`.
You and your collaborators can *edit these files at the same time*,
which means your changes are synchronized among all of you in real-time!
Depending on the type of the file, it allows you to accomplish a specific task.
They open up in their associated online editor and you start to work interactively in CoCalc's environment.
with changes synchronized among all of you in real-time!
Different types of files open up in their associated online editors and you start to work interactively in CoCalc's environment.
For example, files ending in ``*.sagews`` are for working with [SageMath]_ in :doc:`sagews`,
an ``*.ipynb`` file starts CoCalc's implementations of the :doc:`Jupyter Notebook <jupyter>`,
and a ``*.tex`` file opens an editor for :doc:`LaTeX documents <latex>`.
``*.ipynb`` files start CoCalc's implementations of the :doc:`Jupyter Notebook <jupyter>`,
and ``*.tex`` files open an editor for :doc:`LaTeX documents <latex>`.

.. figure:: img/cocalc-screenshot-20200123.png
:width: 100%
:width: 90%
:align: center
:alt: jupyter notebook

*A SageMath Jupyter Notebook in a CoCalc project*
A SageMath Jupyter Notebook in a CoCalc project


#######################
Getting Started
Try It Out
#######################

To try out CoCalc, you might do the following steps.
Expand All @@ -60,26 +56,16 @@ To try out CoCalc, you might do the following steps.
First Steps Guide
#######################

As an alternative to the "Getting Started" steps above, you can use the **First Steps Guide**. Whenever a new project is created, a banner appears offering to create a set of files constituting Guide:
As an alternative to the steps above, you can use the **First Steps Guide**. Whenever a new project is created, a banner appears offering to create a set of files constituting the Guide:

.. figure:: img/first-steps-message.png
:width: 100%
:width: 90%
:align: center
:alt: first steps banner

..
Clicking on the banner puts copies of the Guide files into the project in a folder called "first-steps" and opens the file "first-steps.task"

If you don't want the guide copied at the moment, you can dismiss the banner. And you can always bring the banner back later if you change your mind:

.. figure:: img/first-steps-hide.png
:width: 100%
:align: center
:alt: dismiss first steps banner

..
:alt: First Steps Guide Banner

First Steps Guide Banner

Clicking on the banner puts copies of the Guide files into the project in a folder called ``first-steps`` and opens the file ``first-steps.task``.



Expand Down
1 change: 1 addition & 0 deletions _sources/introduction.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Introduction
.. toctree::

index
why
getting-started
news
tours
Expand Down
50 changes: 50 additions & 0 deletions _sources/why.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
Why CoCalc?
===========

What a great question! You are probably the only one who can answer it correctly for your use case, but if you are new to CoCalc and considering adopting it for your own workflow or for your organization, we would like to help you.

To compare individual features with some of our competitors, take a look at https://cocalc.com/features/compare

If you are wondering about some specific requirements, reach out to us at [email protected] and perhaps schedule a video chat.

We assume that you are aware of advantages (and some disadvantages) of working in the cloud rather than your own laptop, but there are quite a few cloud options out there. So, what makes CoCalc different from them?


Open World Approach
-------------------

CoCalc strives to give you as much flexibility as possible. Instead of deciding what you are allowed to do, we only put in place necessary security limits and, of course, have to deal with technical ones. Moreover, we try to push even those limits! You can't be root in :doc:`regular CoCalc projects <project>`, but you can :ref:`request installation <install-request>` of any necessary packages and you can :ref:`install anything as a regular user <python-pkg-install-user>`. On :doc:`compute servers <compute_server>` you are able to do anything on the underlying virtual machines, including creation of nested virtual machines! There are UI libraries that are not supported by our Jupyter notebook implementation, but we do try to improve it and you can run a standard :doc:`JupyterLab or VS Code <servers>` instance with a click of a button!

We want to facilitate access to open source software. This should not come as a surprise, given that our founder and CEO William Stein is also the founder of `SageMath <https://www.sagemath.org/>`_ whose mission is to be a viable open source alternative to proprietary math software. Some other people in the company were early developers of SageMath as well. While Python and Jupyter may be particularly famous, we have extensive support for R, Julia, LaTeX, C++, VS Code, and many other projects, languages, packages, and environments. We try to reduce "the setup time" as much as possible for our users, ideally - to zero! Most of our competitors have a narrower focus and even if they do include a large software collection, such as Colab (which you :ref:`can run <colab_example>` on CoCalc's compute servers), it may be tricky to expand it with packages that you need.

CoCalc's flexibility sometimes may create a feeling of a more complicated/overloaded interface. If your goal is to have a single feature, say Linux terminals, and nothing else, then perhaps there are easier to learn alternatives for your use case. However, if your needs may grow over time, you may find more and more ways to make use of CoCalc. We are also trying to separate "essential" elements and configuration options from "advanced" ones, to keep it simple yet powerful.


No Vendor Lock-In
-----------------

While most of our `source code <https://github.com/sagemathinc/cocalc>`_ and configuration files are public, we put restrictions on running your own instance without :doc:`purchasing a license <cocalc-cloud>`. We do have our own implementation of the Jupyter notebook interface and :doc:`Sage Worksheet format <sagews>` is specific to our platform. Yet you remain in full control of your data and code, CoCalc acts more like an operating system that allows you to run your code to process your data. Sage Worksheets can be converted to Jupyter notebooks. "Our" Jupyter notebooks are standard ``.ipynb`` files that you can download and use on your own machine or on another cloud provider, should you decide down the road that CoCalc no longer serves your needs.


Full Control of the Software Stack
----------------------------------

Core functionality of CoCalc, including our implementation of the Jupyter notebook interface, real-time collaboration, :doc:`AI integration <ai>`, :doc:`TimeTravel <time-travel>`, and :doc:`course management <teaching-instructors>`, is developed by `CoCalc team <https://cocalc.com/about/team>`_. As a consequence, we support the product that we know very well and we can quickly fix reported bugs as well as develop requested features for it (especially if you have funds available to facilitate such development). CoCalc does not have an extensive library of plugins and extensions of varied quality and support; instead all the features are included and maintained from the start.


On Premises Option
------------------

Using our fully hosted version greatly reduced administration burden for your organization, but there are situations where you may prefer to run your own cluster - maybe because of privacy requirements, maybe because you already have hardware resources and dedicated IT professionals. :doc:`CoCalc Cloud <cocalc-cloud>` can be deployed on your own resources or on cloud providers such as GCP, AWS, or Aliyun. CoCalc's AI integration can be easily tuned to use your own AI servers as well.


Responsive Support Team
-----------------------

In most cases we do not provide support SLAs (contact us if you are interested in such an option), but historically our response time was within a few hours - our team is geographically distributed, so urgent issues are dealt with regardless of your time zone. Due to service monitoring, many problems on the instances that we host are likely to be fixed even before you notice and report them. As your needs grow, we are with you along the way to provide extended enterprise support and custom feature implementation.


Next Steps
----------

`Create an account <https://cocalc.com/auth/sign-up>`_, give CoCalc a spin, and get in touch with your questions and comments - we would love to connect!
2 changes: 1 addition & 1 deletion compute_server.html
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ <h2><a class="toc-backref" href="#id21" role="doc-backlink">CoCalc’s Most Uniq
</ul>
</section>
<section id="examples-of-compute-server-uses">
<h2><a class="toc-backref" href="#id22" role="doc-backlink">Examples of Compute Server Uses</a><a class="headerlink" href="#examples-of-compute-server-uses" title="Link to this heading"></a></h2>
<span id="colab-example"></span><h2><a class="toc-backref" href="#id22" role="doc-backlink">Examples of Compute Server Uses</a><a class="headerlink" href="#examples-of-compute-server-uses" title="Link to this heading"></a></h2>
<p>You may find something useful, at least some inspiration, in our growing <a class="reference external" href="https://github.com/sagemathinc/cocalc-howto/blob/main/README.md">collection of tutorials</a> that showcase compute servers. You can simply read them or follow along in video format. Here CoCalc’s CEO and Founder William Stein explains how to run the Google Colab environment on compute servers and use either Tensorflow or PyTorch:</p>
<center><iframe width="640" height="360" src="https://www.youtube.com/embed/kcxyShH3wYE?si=rGZEWZgs6XbOF38u" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></center>
<br/></section>
Expand Down
1 change: 1 addition & 0 deletions contents.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ <h1>Welcome to CoCalc’s User Manual!<a class="headerlink" href="#welcome-to-co
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="index.html">What is CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="why.html">Why CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting-started.html">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="news.html">CoCalc News</a></li>
<li class="toctree-l2"><a class="reference internal" href="tours.html">Tours</a></li>
Expand Down
5 changes: 3 additions & 2 deletions getting-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="CoCalc News" href="news.html" />
<link rel="prev" title="What is CoCalc?" href="index.html" />
<link rel="prev" title="Why CoCalc?" href="why.html" />

<link rel="stylesheet" href="_static/custom.css" type="text/css" />

Expand Down Expand Up @@ -60,6 +60,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="introduction.html">Introduction</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="index.html">What is CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="why.html">Why CoCalc?</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Getting Started</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#your-first-cocalc-session">Your First CoCalc Session</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#creating-an-account">Creating an Account</a></li>
Expand Down Expand Up @@ -291,7 +292,7 @@ <h3><a class="toc-backref" href="#id13" role="doc-backlink">Statements</a><a cla
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="What is CoCalc?" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="why.html" class="btn btn-neutral float-left" title="Why CoCalc?" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="news.html" class="btn btn-neutral float-right" title="CoCalc News" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

Expand Down
1 change: 1 addition & 0 deletions howto/cant-save.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../introduction.html">Introduction</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../index.html">What is CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../why.html">Why CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting-started.html">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="../news.html">CoCalc News</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tours.html">Tours</a></li>
Expand Down
1 change: 1 addition & 0 deletions howto/clock-is-off.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../introduction.html">Introduction</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../index.html">What is CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../why.html">Why CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting-started.html">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="../news.html">CoCalc News</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tours.html">Tours</a></li>
Expand Down
1 change: 1 addition & 0 deletions howto/connectivity-issues.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../introduction.html">Introduction</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../index.html">What is CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../why.html">Why CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting-started.html">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="../news.html">CoCalc News</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tours.html">Tours</a></li>
Expand Down
1 change: 1 addition & 0 deletions howto/disk-space-warning.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../introduction.html">Introduction</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../index.html">What is CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../why.html">Why CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting-started.html">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="../news.html">CoCalc News</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tours.html">Tours</a></li>
Expand Down
1 change: 1 addition & 0 deletions howto/file-too-large.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../introduction.html">Introduction</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../index.html">What is CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../why.html">Why CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting-started.html">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="../news.html">CoCalc News</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tours.html">Tours</a></li>
Expand Down
1 change: 1 addition & 0 deletions howto/gap-kernel-unavailable.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../introduction.html">Introduction</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../index.html">What is CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../why.html">Why CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting-started.html">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="../news.html">CoCalc News</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tours.html">Tours</a></li>
Expand Down
1 change: 1 addition & 0 deletions howto/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../introduction.html">Introduction</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../index.html">What is CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../why.html">Why CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting-started.html">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="../news.html">CoCalc News</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tours.html">Tours</a></li>
Expand Down
2 changes: 1 addition & 1 deletion howto/install-python-lib.html
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@
</ul>
</nav>
<section id="install-requests">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Install requests</a><a class="headerlink" href="#install-requests" title="Link to this heading"></a></h2>
<span id="install-request"></span><h2><a class="toc-backref" href="#id3" role="doc-backlink">Install requests</a><a class="headerlink" href="#install-requests" title="Link to this heading"></a></h2>
<p>If a package may have general use but is not already installed in CoCalc,
please open a support request to tell us to install it globally for everyone.
Uncomplicated install requests are typically handled within 1 business day for paying customers.
Expand Down
1 change: 1 addition & 0 deletions howto/jupyter-kernel-terminated.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../introduction.html">Introduction</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../index.html">What is CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../why.html">Why CoCalc?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting-started.html">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="../news.html">CoCalc News</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tours.html">Tours</a></li>
Expand Down
Loading

0 comments on commit d8df161

Please sign in to comment.