smc-dev.tex

\documentclass{beamer}
\usepackage{graphicx}
\usepackage{url}

\mode<presentation> {
\usetheme{Madrid}
}

\usepackage{graphicx}
\usepackage{booktabs}

\title[SageMathCloud]{How to Contribute to SageMathCloud}
\author{William Stein}
\institute[UW]
{
University of Washington \\
\medskip
SageMath, Inc.
}
\date{\today}

\begin{document}

\begin{frame}
\titlepage
\end{frame}

\begin{frame}
\frametitle{Screencast of this talk}
\vfill
\Large
\begin{center}
\url{https://youtu.be/GOuy07Kift4}
\end{center}
\vfill
\end{frame}

\begin{frame}[fragile]
\frametitle{Goal of talk}

{\bf Goal: } Explain how to work on SageMathCloud.
\vfill

{\bf Motivation: } I do around 95\% of SMC development:
\begin{verbatim}
    > git log |grep Author |wc -l
    9763
    > git log |grep "Author: William Stein" |wc -l
    9340
    > git ls-files -z | stack overflow ...
 278358 William Stein
   5582 Harald Schilly
   2622 Nicholas Ruhland
   1117 William Jon Nich
    909 Jon Nich ...
\end{verbatim}

\vfill
{\bf This must stop!!!}


\end{frame}

\begin{frame}
\frametitle{What is SMC?}

\begin{itemize}
\item
{\bf Launch:} I launched SMC in April 2013.
\item
{\bf Size:} SMC runs on dozens of VM's on Google compute engine.  250K projects made.  Over 30K monthly active users.  Over 850 simultaneous users.
\item
{\bf Features:} realtime collaboration, LaTeX editing, Sage worksheets, R, Jupyter notebooks, color terminals, write Fortran/C/C++/Java/Haskell/etc. programs, todo lists, course management, chatrooms.
\item
{\bf Devel:} SMC can also now be run in a new single-user developer-friendly mode.
\end{itemize}

\end{frame}

\begin{frame}
\frametitle{The Stack}

\begin{itemize}
\item {\bf Node.js:} javascript on server side; amazing ecosystem
\item {\bf CoffeeScript:} Javascript preparser -- no braces and semicolons
\item {\bf Engine.io/Primus:} websockets + fallback
\item {\bf React.js:} sane declarative user interfaces
\item {\bf RethinkDB:} scalable, replicated database that pushes changes (=nosql db + message queue)
\item {\bf SageMath:} mathematics
\item {\bf Jupyter Notebook:} interactive coding
\item {\bf webpack:} bundles all assets of webpage
\item {\bf LaTeX:} math typesetting: backend in Linux and mathjax on frontend
\end{itemize}
\end{frame}

\begin{frame}
\frametitle{Contributing to SMC}

\begin{itemize}
\item {\bf Use Github:} \url{https://github.com/sagemathinc/smc}

\item {\bf SMC dev:} (1) in an SMC project, (2) on Linux/OS X

\item {\bf License:} GPLv3+ compatible.
\end{itemize}

\end{frame}

\begin{frame}
\frametitle{Tutorial -- part 1: setup SMC dev environment (15 min)}

\begin{enumerate}
\item (2 min) In SMC, open or create a SMC project.  On a laptop, install Node.js V5 and RethinkDB, and make sure python=python2.7.

\item (3 min) Open a terminal and clone the repo:

        {\tt git clone https://github.com/sagemathinc/smc}

\item (1 min) Right now you must checkout the smc-in-smc branch (this will change): {\tt cd smc/; git checkout smc-in-smc}

\item (8 min) Build/install everything (uses nearly 1GB disk):

        {\tt cd src; . smc-env; npm run make}

\item (1 min) Start everything (needs more than 1GB RAM to work smoothly):

        {\tt cd dev/project; ./tmux-start-all}

This uses tmux, but you can instead directly start the three scripts in that directory.

\end{enumerate}
\end{frame}

\begin{frame}[fragile]
\frametitle{BUGS!!!!!!!}
There are several devel bugs right now.  I will fix these this week.
\begin{itemize}

\item The first time after everything starts up, you will have to stop it all and start it again.  (hub websocket server may not properly initialize the first time, when the database takes a long time to get configured.)

\item On a laptop, you must do
\verb+pip install ~/smc/src/smc_pyutil/+ to install various scripts systemwide.

\item In an SMC project, {\em anybody} with a project on the same host could connect to and modify your RethinkDB instance!  However, they can't login to your server.

\item To test modifications to the sage server, you have to install {\tt smc\_sagews} into the project via {\tt pip install --user /path/to/smc/src/smc\_sagews/}

\item Proxy server {\bf not implemented}: IPython, Latex, project in project in project

\end{itemize}

\end{frame}

\begin{frame}
\frametitle{Tutorial -- part 2: exercises}

\begin{enumerate}

\item {\bf Change frontend UI:} Help page: change "Support" $\longrightarrow$ "Mom's favorites".

\item {\bf Change backend hub:} When creating account, change user's name to Super Mom.

\item {\bf Change local hub:} When opening a file, put 'HI MOM!' at the top.

\item {\bf Change console server:} Write 'HI MOM!' to terminal stream whenever opened.

\item {\bf Change Sage server:} Define extra variable in Sage worksheets called MOM.

\end{enumerate}

\end{frame}

\begin{frame}
\frametitle{Change frontend UI}
{\bf Exercise:} Help page -- change "Support" $\longrightarrow$ "Mom's favorites".
\vfill

\begin{enumerate}
\item Open {\tt smc/src/smc-webapp/r\_help.cjsx}
\item Change "Support" to "Random links"
\item When you save, webpack will update
\item Refresh help page and see change (react hot loader not yet implemented in SMC)
\end{enumerate}

\vfill

Someday:
\url{http://gaearon.github.io/react-hot-loader/}

\end{frame}

\begin{frame}
\frametitle{Change backend hub}
{\bf Exercise:} When creating account, change user's name to Super Mom.

\begin{enumerate}
\item Open {\tt smc/src/smc-hub/hub.coffee}
\item Note that it is way too big and needs to be refactored...
\item Find the function {\tt create\_account}
\item Add this code: {\tt mesg.first\_name = "Super"; mesg.last\_name = "Mom"}
\item Stop the hub and start it again: (1) use tmux to get to the hub log, hit control+c to stop it.  (2) start it again in a separate terminal session, make new account, verify result.

\end{enumerate}


\end{frame}

\begin{frame}
\frametitle{Change local hub}
{\bf Exercise:} When opening a file, put 'HI MOM!' at the top.

\begin{enumerate}
\item Open {\tt smc/src/smc-project/local\_hub.coffee}
\item Look for lines involving {\tt fs.readFile}, and find {\tt @init(doc:data.toString()...}
\item Change it to {\tt @init(doc:'Hi Mom!' + data.toString()...}
\item Create a project and open it (NOTE: will get an error on first directory load!!)
\item Open a file
\end{enumerate}


\end{frame}

\begin{frame}
\frametitle{Change console server}
{\bf Exercise:} Write 'HI MOM!' to terminal stream whenever opened.

\begin{enumerate}
\item Open {\tt smc/src/smc-project/console\_server\_child.coffee}
\item Put this line at the bottom: {\tt socket.write("HI MOM!")}
\item Open a terminal (restart project if you had already opened a terminal!).  Maybe hit return a few times. See "HI MOM!".
\end{enumerate}


\end{frame}

\begin{frame}
\frametitle{Change Sage server}
{\bf Exercise:}  Define extra variable in Sage worksheets called MOM.
\begin{enumerate}
\item Open {\tt smc/src/smc\_sagews/smc\_sagews/sage\_server.py}
\item Search in the file for {\tt \_\_SAGEWS\_\_}
\item Add this line after it: {\tt namespace['MOM'] = "hi there!"}
\item (TEMPORARY-BUG) Install sage\_server code {\em into a nested project}: {\tt pip install --user /projects/[your project id]/smc/src/smc\_sagews/}
\item Open a Sage worksheet in your nexted project and type MOM (shift+enter) and see if it worked.  (If it didn't, restart your sage server.)
\end{enumerate}


\end{frame}




\end{document}