Skip to content

Commit

Permalink
docs now list required MATLAB toolboxes
Browse files Browse the repository at this point in the history
  • Loading branch information
sg-s committed Jun 24, 2020
1 parent c2bfbd1 commit 59dd5f4
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 2 deletions.
2 changes: 1 addition & 1 deletion +xolotl/version.m
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
function version()
disp('v20.6.16');
disp('v20.6.24');
33 changes: 33 additions & 0 deletions docs/reference/matlab/xolotl.md
Original file line number Diff line number Diff line change
Expand Up @@ -546,6 +546,35 @@ x.manipulate('*gbar');



-------

### download


**Syntax**

```matlab
x.download;
```

**Description**

Downloads a pre-complied binary for
this model, if available.







!!! info "See Also"
* [xolotl.compile](../xolotl/#compile)
* [xolotl.viewCode](../xolotl/#viewcode)




-------

### fI
Expand Down Expand Up @@ -1005,6 +1034,10 @@ This method supports tab completion. You should be able to
press tab and get a list of snapshots that you want to
reset to.

% !!! warning
reset will not change the values of `I_ext` and `V_clamp`




!!! info "See Also"
Expand Down
5 changes: 4 additions & 1 deletion docs/tutorials/start-here.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ In this tutorial we will walk through the steps required to install `xolotl`
and make sure everything works well. You will need:

1. [MATLAB](https://www.mathworks.com/products/matlab.html) (`xolotl` will not work on GNU Octave)
2. An internet connection
2. [The parallel computing toolbox](https://www.mathworks.com/products/parallel-computing.html) (for running simulations in parallel)
3. [The Signal Processing toolbox](https://www.mathworks.com/products/signal.html) (for some analysis code)
4. [Global Optimization toolbox](https://www.mathworks.com/products/global-optimization.html) (to fit models to data)
5. An internet connection

## Installing xolotl

Expand Down

0 comments on commit 59dd5f4

Please sign in to comment.