Skip to content

jlutgen/smc

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

logo SageMathCloud (SMC)

A collaborative web-based interface to Sage, IPython, LaTeX and the Terminal

Website

Development/install

  • git clone https://github.com/sagemathinc/smc -- copy repo
  • npm install -- build dependencies
  • npm run make -- build coffeescript, javascript, bundle it up, etc.
  • npm test -- run test suite
  • npm run coverage -- determine test coverage (creates coverage/) directory

Contributors

  • William Stein, SageMath Inc and University of Washington -- founder; coding and design
  • Harald Schilly, Vienna, Austria -- marketing, QA, coding
  • Jon Lee, University of Washington -- frontend work, history viewer
  • Rob Beezer, University of Puget Sound -- design, maintenance
  • Nicholas Ruhland, University of Washington -- frontend work, tab reordering and resizing
  • Keith Clawson -- hardware/infrastructure
  • Andy Huchala, University of Washington -- frontend work, bug finding

Copyright/License

SMC is 100% open source, released under the GNU General Public License version 3+:

Copyright (C) 2014, 2015, William Stein

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Build Status: Testing and Coverage

We test SMC via Travis CI. Here are the results for important branches:

DevOps note: The relevant files are:

  • .travis.yml - to tell travis-ci what to do (two modes: client and server)
  • salvus/test/mocha.opts - defaults for running mocha
  • salvus/package.json - the "scripts" section (overwrite mocha reporter, only call coveralls when on travis-ci, etc.)
  • salvus/coffee-coverage-loader.js - configuration for the istanbul coffeescript coverage (server side)

Dependencies

See the file build.py.

Python

Javascript/CSS/HTML

  • CoffeeScript -- all our Javascript is written using CoffeeScript
  • React.js
  • jQuery, jQuery-ui -- http://jquery.org/; MIT license
  • Bootstrap -- apache license
  • codemirror -- http://codemirror.net/; basically MIT license
  • Primus
  • and many, many more!

NodeJS

  • Many, many npm modules; see package.json

Other Relevant Software

ARCHITECTURE

  • SSL -- stunnel
  • Client -- javascript client library that runs in web browser
  • Load balancer-- HAproxy
  • Database -- RethinkDB
  • Compute -- VM's running TCP servers (e.g., sage, console, projects, python3, R, etc.)
  • Hub -- written in Node.js; primus server; connects with everything -- compute servers, database, other hubs, and clients.
  • HTTP server -- Nginx static http server
  • admin.py -- Python program that uses the paramiko library to start/stop everything
  • Public Cloud -- Google Compute Engine

Architectural Diagram

   Client    Client    Client   Client  ...
     /|\
      |
   https://cloud.sagemath.com (stunnel, primus)
      |
      |
     \|/
 HAproxy (load balancing...)HAproxy                  Admin     (monitor and control system)
 /|\       /|\      /|\      /|\
  |         |        |        |
  |http1.1  |        |        |
  |         |        |        |
 \|/       \|/      \|/      \|/
 Hub<----> Hub<---->Hub<---> Hub  <-----------> RethinkDB <--> RethinkDB  <--> Cassandra ...
           /|\      /|\      /|\
            |        |        |
   ---------|        |        | (tcp)
   |                 |        |
   |                 |        |
  \|/               \|/      \|/
 Compute<-------->Compute<-->Compute <--- rsync replication  to Storage Server, which has BTRFS snapshots

About

SageMathCloud's complete current source code repository -- use SMC at

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 46.1%
  • CoffeeScript 27.6%
  • Python 12.6%
  • HTML 11.1%
  • CSS 1.6%
  • Tcl 0.8%
  • Other 0.2%