Giter Club home page Giter Club logo

mmnote's Introduction

SOLVCON implements conservation-law solvers that use the space-time Conservation Element and Solution Element (CESE) method.

Documentation Status

Install

Clone from https://github.com/solvcon/solvcon:

$ git clone https://github.com/solvcon/solvcon

SOLVCON needs the following packages: A C/C++ compiler supporting C++11, cmake 3.7+, pybind11 Git master, Python 3.6+, Cython 0.16+, Numpy 1.5+, LAPACK, NetCDF 4+, SCOTCH 6.0+, Nose 1.0+, Paramiko 1.14+, boto 2.29.1+, and gmsh 3+. Support for VTK is to be enabled for conda environment.

To install the dependency, run the scripts contrib/conda.sh and contrib/build-pybind11-in-conda.sh (they use Anaconda).

The development version of SOLVCON only supports local build:

$ make; python setup.py build_ext --inplace

To build SOLVCON from source code and install it to your system:

$ make; make install

Test the build:

$ nosetests --with-doctest
$ nosetests ftests/gasplus/*

Building document requires Sphinx 1.3.1+, pstake 0.3.4+, and graphviz 2.28+. Use the following command:

$ make -C doc html

The document will be available at doc/build/html/.

mmnote's People

Contributors

en-chou avatar tai271828 avatar yungyuc avatar

Stargazers

avatar

Watchers

avatar avatar avatar avatar

Forkers

yungyuc en-chou tai271828 xingularity terrychan999 kuomc

mmnote's Issues

Add tex linter to Makefile and CI

There should be a linter for the tex plain text source file. We do not need to have a complete convention at the moment. The only thing to enforce in the beginning is the 79-char line width (matching Python PEP-8).

The task may have two step. The first step is to add the linter to the make file. The second needs to be done after CI is available (#5).

Add CI to build PDF

Github Actions workflow should be created to build the PDF on each push, PR, and nightly.

Use subscripts for axes

Use $x_1$ for the $x$ coordinate and $x_2$ for the $y$ coordinate. Do not use $x$ and $y$ explicitly.

Fix inconsistent symbols in projection

Some symbols are not consistently used in the projection note. For example, in

mmnote/projection.tex

Line 85 in 2e5b4cf

\frac{\partial v_1}{\partial t}+v_1 \frac{\partial v_1}{\partial x_1}+v_2 \frac{\partial v_1}

the velocity uses v. But in

mmnote/projection.tex

Line 119 in 2e5b4cf

Velocity at $n^{th}$ time-step is denoted as $\mathbf{u}^n$. Convection term is

the velocity uses \mathbf{u}. They should consistently uses v.

There might be other inconsistent symbols, but the velocity is the most obvious one that needs to be corrected.

Add FDTD notes

Adding FDTD related notes. Including basic FDTD concepts and a few typical cases.

build empty pdf 

$ make
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/cce.tex turgon_eps/cce.eps 2>&1 | \
	tee log/pstake-cce.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/cese_marching.tex turgon_eps/cese_marching.eps 2>&1 | \
	tee log/pstake-cese_marching.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/crossse.tex turgon_eps/crossse.eps 2>&1 | \
	tee log/pstake-crossse.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/ctau.tex turgon_eps/ctau.eps 2>&1 | \
	tee log/pstake-ctau.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/elm_hex.tex turgon_eps/elm_hex.eps 2>&1 | \
	tee log/pstake-elm_hex.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/elm_ln.tex turgon_eps/elm_ln.eps 2>&1 | \
	tee log/pstake-elm_ln.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/elm_psm.tex turgon_eps/elm_psm.eps 2>&1 | \
	tee log/pstake-elm_psm.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/elm_pym.tex turgon_eps/elm_pym.eps 2>&1 | \
	tee log/pstake-elm_pym.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/elm_quad.tex turgon_eps/elm_quad.eps 2>&1 | \
	tee log/pstake-elm_quad.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/elm_tet.tex turgon_eps/elm_tet.eps 2>&1 | \
	tee log/pstake-elm_tet.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/elm_tri.tex turgon_eps/elm_tri.eps 2>&1 | \
	tee log/pstake-elm_tri.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/mesh_2d_ce.tex turgon_eps/mesh_2d_ce.eps 2>&1 | \
	tee log/pstake-mesh_2d_ce.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/mesh_2d_tri.tex turgon_eps/mesh_2d_tri.eps 2>&1 | \
	tee log/pstake-mesh_2d_tri.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/nonuni_se.tex turgon_eps/nonuni_se.eps 2>&1 | \
	tee log/pstake-nonuni_se.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/nonuni.tex turgon_eps/nonuni.eps 2>&1 | \
	tee log/pstake-nonuni.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/se_flux.tex turgon_eps/se_flux.eps 2>&1 | \
	tee log/pstake-se_flux.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/tube_at_rest.tex turgon_eps/tube_at_rest.eps 2>&1 | \
	tee log/pstake-tube_at_rest.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/tube_move_right.tex turgon_eps/tube_move_right.eps 2>&1 | \
	tee log/pstake-tube_move_right.tex.log > /dev/null
mkdir -p log ; \
mkdir -p turgon_eps ; python3 ./pstake.py schematic/tube_zones.tex turgon_eps/tube_zones.eps 2>&1 | \
	tee log/pstake-tube_zones.tex.log > /dev/null
Having EPS files: turgon_eps/cce.eps turgon_eps/cese_marching.eps turgon_eps/crossse.eps turgon_eps/ctau.eps turgon_eps/elm_hex.eps turgon_eps/elm_ln.eps turgon_eps/elm_psm.eps turgon_eps/elm_pym.eps turgon_eps/elm_quad.eps turgon_eps/elm_tet.eps turgon_eps/elm_tri.eps turgon_eps/mesh_2d_ce.eps turgon_eps/mesh_2d_tri.eps turgon_eps/nonuni_se.eps turgon_eps/nonuni.eps turgon_eps/se_flux.eps turgon_eps/tube_at_rest.eps turgon_eps/tube_move_right.eps turgon_eps/tube_zones.eps turgon_eps/cese_marching.eps turgon_eps/nonuni_se.eps turgon_eps/se_flux.eps
mkdir -p log ; num=1 ; while [ $num -le 3  ] ; do \
	latex_logfile=log/cese.dvi.latex.$num.log ; \
	echo -n "latex cese.dvi #$num ... " ; \
	latex -halt-on-error -interaction=nonstopmode -synctex=1 cese.tex 2>&1 | \
		tee $latex_logfile > /dev/null ; \
	if [[ \
		   ( -z "`grep 'LaTeX Error:' $latex_logfile`" ) \
		&& ( -z "`grep 'Runaway argument\?' $latex_logfile`" ) \
		&& ( -z "`grep \! $latex_logfile | head -c 1 | grep \!`" ) \
	]] ; then \
		echo "done" ; \
	else \
		echo "tail $latex_logfile:" ; \
		tail $latex_logfile ; \
		exit -1 ; \
	fi ; \
	bibtex cese 2>&1 | \
		tee log/cese.dvi.bibtex.$num.log \
		> /dev/null ; \
(( num = num + 1 )) ; done
latex cese.dvi #1 ... done
latex cese.dvi #2 ... done
latex cese.dvi #3 ... done
mkdir -p log ; \
dvips cese.dvi 2>&1 | tee log/cese.ps.log > /dev/null
mkdir -p log ; \
ps2pdf -dALLOWPSTRANSPARENCY cese.ps 2>&1 | tee log/cese.pdf.log > /dev/null
Having EPS files: turgon_eps/cce.eps turgon_eps/cese_marching.eps turgon_eps/crossse.eps turgon_eps/ctau.eps turgon_eps/elm_hex.eps turgon_eps/elm_ln.eps turgon_eps/elm_psm.eps turgon_eps/elm_pym.eps turgon_eps/elm_quad.eps turgon_eps/elm_tet.eps turgon_eps/elm_tri.eps turgon_eps/mesh_2d_ce.eps turgon_eps/mesh_2d_tri.eps turgon_eps/nonuni_se.eps turgon_eps/nonuni.eps turgon_eps/se_flux.eps turgon_eps/tube_at_rest.eps turgon_eps/tube_move_right.eps turgon_eps/tube_zones.eps turgon_eps/cese_marching.eps turgon_eps/nonuni_se.eps turgon_eps/se_flux.eps
mkdir -p log ; num=1 ; while [ $num -le 3  ] ; do \
	latex_logfile=log/ustmesh.dvi.latex.$num.log ; \
	echo -n "latex ustmesh.dvi #$num ... " ; \
	latex -halt-on-error -interaction=nonstopmode -synctex=1 ustmesh.tex 2>&1 | \
		tee $latex_logfile > /dev/null ; \
	if [[ \
		   ( -z "`grep 'LaTeX Error:' $latex_logfile`" ) \
		&& ( -z "`grep 'Runaway argument\?' $latex_logfile`" ) \
		&& ( -z "`grep \! $latex_logfile | head -c 1 | grep \!`" ) \
	]] ; then \
		echo "done" ; \
	else \
		echo "tail $latex_logfile:" ; \
		tail $latex_logfile ; \
		exit -1 ; \
	fi ; \
	bibtex ustmesh 2>&1 | \
		tee log/ustmesh.dvi.bibtex.$num.log \
		> /dev/null ; \
(( num = num + 1 )) ; done
latex ustmesh.dvi #1 ... done
latex ustmesh.dvi #2 ... done
latex ustmesh.dvi #3 ... done
mkdir -p log ; \
dvips ustmesh.dvi 2>&1 | tee log/ustmesh.ps.log > /dev/null
mkdir -p log ; \
ps2pdf -dALLOWPSTRANSPARENCY ustmesh.ps 2>&1 | tee log/ustmesh.pdf.log > /dev/null
Having EPS files: turgon_eps/cce.eps turgon_eps/cese_marching.eps turgon_eps/crossse.eps turgon_eps/ctau.eps turgon_eps/elm_hex.eps turgon_eps/elm_ln.eps turgon_eps/elm_psm.eps turgon_eps/elm_pym.eps turgon_eps/elm_quad.eps turgon_eps/elm_tet.eps turgon_eps/elm_tri.eps turgon_eps/mesh_2d_ce.eps turgon_eps/mesh_2d_tri.eps turgon_eps/nonuni_se.eps turgon_eps/nonuni.eps turgon_eps/se_flux.eps turgon_eps/tube_at_rest.eps turgon_eps/tube_move_right.eps turgon_eps/tube_zones.eps turgon_eps/cese_marching.eps turgon_eps/nonuni_se.eps turgon_eps/se_flux.eps
mkdir -p log ; num=1 ; while [ $num -le 3  ] ; do \
	latex_logfile=log/projection.dvi.latex.$num.log ; \
	echo -n "latex projection.dvi #$num ... " ; \
	latex -halt-on-error -interaction=nonstopmode -synctex=1 projection.tex 2>&1 | \
		tee $latex_logfile > /dev/null ; \
	if [[ \
		   ( -z "`grep 'LaTeX Error:' $latex_logfile`" ) \
		&& ( -z "`grep 'Runaway argument\?' $latex_logfile`" ) \
		&& ( -z "`grep \! $latex_logfile | head -c 1 | grep \!`" ) \
	]] ; then \
		echo "done" ; \
	else \
		echo "tail $latex_logfile:" ; \
		tail $latex_logfile ; \
		exit -1 ; \
	fi ; \
	bibtex projection 2>&1 | \
		tee log/projection.dvi.bibtex.$num.log \
		> /dev/null ; \
(( num = num + 1 )) ; done
latex projection.dvi #1 ... done
latex projection.dvi #2 ... done
latex projection.dvi #3 ... done
mkdir -p log ; \
dvips projection.dvi 2>&1 | tee log/projection.ps.log > /dev/null
mkdir -p log ; \
ps2pdf -dALLOWPSTRANSPARENCY projection.ps 2>&1 | tee log/projection.pdf.log > /dev/null

image

Create a badge to download the generated notes

We can now reserve the artifacts from CI and download them for accessing generated notes. However, the step to access the artifacts is not straightforward. It will be more handy if we can link the latest artifacts with a badge in the landing README.

More context, see this comment from issue #5 .

Possible solution:

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.