Documentation

Author: 2xmax

Readme.md

@@ -2,23 +2,27 @@
 
 This repository provides source code for Maximov MA, Galukhin AV, and Gor GY, "Pore Size Distribution of Silica Colloidal Crystals from Nitrogen Adsorption Isotherms", Langmuir 2019 (accepted)
 
-In short, it generates a kernel of adsorption and desorption isotherms using Frenkel-Halsey-Hill and Derjaguin-Broekhoff-de Boer theories and extracts the pore size distribution using Non-Negative Least Squares regression with Tikhonov (ridge) regularization and Generalized Cross-validation.
+In short, it generates a kernel of adsorption and desorption isotherms using Frenkel-Halsey-Hill and Derjaguin-Broekhoff-de Boer theories and extracts the pore size distribution using Non-Negative Least Squares regression with Tikhonov (ridge) regularization and Generalized Cross-Validation.
 
-![alt text](https://github.com/2xmax/dbdb_private/blob/docs/docs/TOC.png?raw=true "Logo Title Text 1")
+![alt text](https://github.com/2xmax/dbdb_private/blob/docs/docs/TOC.png?raw=true "TOC")
 
 Quick start
 ===========
-To run examples from docs, run ```pip install . && pip install -r requirements.docs.txt && jupyter notebook``` in terminal/cmd and open the notebooks in your browser. Python 3.5+ is required for the source code, 3.6+ is required for the notebooks with examples.
+To install the package without cloning the project, run ```pip install dbdb```.
 
-To install the package without cloning the project, run ```pip install dbdb```
+To run examples from docs, clone the project ```git clone https://github.com/2xmax/dbdb.git && cd dbdb```, run ```pip install . && pip install -r requirements.docs.txt && jupyter notebook``` in terminal/cmd and open the notebooks in your browser. Python 3.5+ is required for the source code, 3.6+ is required for the notebooks with examples.
 
 Description of notebooks:
- - [psd_n2.ipynb](/docs/psd_n2.ipynb) - quick introduction based on the article data
-- [maximov2019lang_figures.ipynb](/docs/maximov2019lang_figures.ipynb) - reproduced pictures from the current article
-- [galukhin2019lang_figures.ipynb](/docs/galukhin2019lang_figures.ipynb) - reproduced pictures from the [previous article](https://doi.org/10.1021/acs.langmuir.8b03476) in series
-- [psd_arc.psd](/docs/psd_n2.ipynb) - application of FHH and DBdB theories on data from [Cychosz, Katie A., et al., Langmuir 28.34 (2012): 12647-12654.](https://doi.org/10.1021/la302362h)
+ - [psd_n2.ipynb](https://nbviewer.jupyter.org/github/2xmax/dbdb/blob/master/docs/psd_n2.ipynb) - quick introduction based on the article data
+- [maximov2019lang_figures.ipynb](https://nbviewer.jupyter.org/github/2xmax/dbdb/blob/master/docs/maximov2019lang_figures.ipynb) - reproduced pictures from the current article
+- [galukhin2019lang_figures.ipynb](https://nbviewer.jupyter.org/github/2xmax/dbdb/blob/master/docs/galukhin2019lang_figures.ipynb) - reproduced pictures from the [previous article](https://doi.org/10.1021/acs.langmuir.8b03476) in series
+- [psd_arc.psd](https://nbviewer.jupyter.org/github/2xmax/dbdb/blob/master/docs/psd_arc.ipynb) - application of FHH and DBdB theories on data from [Cychosz, Katie A., et al., Langmuir 28.34 (2012): 12647-12654.](https://doi.org/10.1021/la302362h)
 
-BibTeX citation:
+Kernels
+===============
+Pre-calculated kernels for the article are available on the [releases page](https://github.com/2xmax/dbdb/releases). If you want to reparametrize it, go to docs/maximov2019lang_figures.ipynb and see how it was done.
+
+BibTeX citation
 ===============
 ```
 @article{maximov2019opals,