Skip to content

Commit 21cead7

Browse files
authored
Merge pull request #108 from KaanS139/master
Updates to openoworm_docs
2 parents c0515dd + 8e6f3da commit 21cead7

File tree

12 files changed

+67
-69
lines changed

12 files changed

+67
-69
lines changed

docs/Community/github.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This page contains a list of repositories maintained by the OpenWorm project on
1010
Repositories
1111
------------
1212

13-
View the full current list [repositories](/Community/repositories/) of repositories on GitHub.
13+
View the full current list [repositories](../Community/repositories/) of repositories on GitHub.
1414

1515
Accessing GitHub
1616
----------------
@@ -84,10 +84,9 @@ Gist is a simple way to share snippets and pastes with others. All gists are Git
8484

8585
How to:
8686

87-
- [Create Gists](https://help.github.com/articles/creating-gists)
88-
- [Embed, Download and Copy Gists](https://help.github.com/articles/embedding-downloading-and-copying-gists)
87+
- [Create Gists](https://docs.github.com/en/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists)
88+
- [Fork and Clone Gists](https://docs.github.com/en/get-started/writing-on-github/editing-and-sharing-content-with-gists/forking-and-cloning-gists)
8989

90-
Read the [latest news and updates](https://github.com/blog/search?page=1&q=gis) on Gists at GitHub.
9190

9291
Creating or Adding New Repositories
9392
-----------------------------------

docs/Projects/DevoWorm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ educational, academic, media-related and collaborative opportunities associated
66

77
## Roadmap
88

9-
DevoWorm is currently divided into three loosely-knit interest areas: developmental dynamics, cybernetics and digital morphogenesis, and reproduction and developmental plasticity. While our main interest is in the nematode *Caenorhabditis elegans*, we are also interested in cross-species comparative work.
9+
DevoWorm is currently divided into three loosely-knit interest areas: developmental dynamics, cybernetics and digital morphogenesis, and reproduction and developmental plasticity. While our main interest is in the nematode _Caenorhabditis elegans_, we are also interested in cross-species comparative work.
1010

1111
**Developmental Dynamics** currently involves using secondary data collected from embryos along with bioinformatic and data science techniques to answer questions regarding the process of early embryogenesis and the timing of later morphogenesis. To address these problems, we have used number of innovative approaches.
1212

1313
**Cybernetics and Digital Morphogenesis** has involved using platforms such as Morphozoic (Cellular Automata) or CompuCell3D (Cellular Potts Model) to better understand physical interactions during embryogenesis and morphogenesis. We have also explored the use of cybernetic models and concepts to better understand the general process of embryogenesis.
1414

15-
**Reproduction and Developmental Plasticity** involves utilizing an evo-devo approach to understand *Caenorhabditis elegans* more generally. Our existing datasets and papers include a focus on larval development and life-history processes. This area of the project also features primary empirical data, based on formal experimental design.
15+
**Reproduction and Developmental Plasticity** involves utilizing an evo-devo approach to understand _Caenorhabditis elegans_ more generally. Our existing datasets and papers include a focus on larval development and life-history processes. This area of the project also features primary empirical data, based on formal experimental design.
1616

1717
Objective | Examples
1818
--- | ---

docs/Projects/community-proj.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Community Outreach subproject
22
=============================
33

4-
The effort to build the OpenWorm open science community is always ongoing. You can find out more about our OpenWorm community on [another page](../Community/community/).
4+
The effort to build the OpenWorm open science community is always ongoing. You can find out more about our OpenWorm community on [another page](../../community/).
55

66
Previous accomplishments
77
------------------------

docs/Projects/datarep.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ Using these different representations separately leads to ad hoc scripting for f
1111

1212
Here is a list of some of the data sets that we have used so far:
1313

14-
- [The Virtual Worm (3D atlas of C. elegans anatomy)](http://caltech.wormbase.org/virtualworm/)
15-
- [The c. elegans connectome (wiring diagram of neurons)](http://www.wormatlas.org/neuronalwiring.html)
16-
- [Cell list of c. elegans](https://docs.google.com/spreadsheet/pub?key=0Avt3mQaA-HaMdGFnQldkWm9oUmQ3YjZ1LXJ4OHFnR0E&output=html)
17-
- [Ion channels used by c. elegans](https://docs.google.com/spreadsheet/pub?key=0Avt3mQaA-HaMdEd6S0dfVnE4blhaY2ZIWDBvZFNjT0E&output=html)
14+
- [The Virtual Worm (3D atlas of _C. elegans_ anatomy)](http://caltech.wormbase.org/virtualworm/)
15+
- [The _C. elegans_ connectome (wiring diagram of neurons)](http://www.wormatlas.org/neuronalwiring.html)
16+
- [Cell list of _C. elegans_](https://docs.google.com/spreadsheet/pub?key=0Avt3mQaA-HaMdGFnQldkWm9oUmQ3YjZ1LXJ4OHFnR0E&output=html)
17+
- [Ion channels used by _C. elegans_](https://docs.google.com/spreadsheet/pub?key=0Avt3mQaA-HaMdEd6S0dfVnE4blhaY2ZIWDBvZFNjT0E&output=html)
1818
- [Database of Worm behavioral phenotypes](http://www.ncbi.nlm.nih.gov/pubmed/23852451)
1919

2020
Currently our work on data collection and representation is divided among four subprojects:
@@ -26,26 +26,26 @@ Currently our work on data collection and representation is divided among four s
2626

2727
Below you can find information about each subproject, see the project’s current roadmap and access the associated data repositories
2828

29-
A lot of data about *C. elegans* is integrated into the model. In this project, we work on what forms we should put these data in to best leverage them for building the model.
29+
A lot of data about _C. elegans_ is integrated into the model. In this project, we work on what forms we should put these data in to best leverage them for building the model.
3030

3131
NeuroML Connectome
3232
------------------
3333

34-
Our computational strategy to accomplish this involves first reusing the *C. elegans* connectome and the 3D anatomical map of the *C. elegans* nervous system and body plan. We have used the NeuroML standard (Gleeson et al., 2010) to describe the 3D anatomical map of the *C. elegans* nervous system. This has been done by discretizing each neuron into multiple compartments, while preserving its three-dimensional position and structure. We have then defined the connections between the NeuroML neurons using the *C. elegans* connectome. Because NeuroML has a well-defined mapping into a system of Hodgkin-Huxley equations, it is currently possible to import the "spatial connectome" into the NEURON simulator (Hines & Carnevale 1997) to perform in silico experiments.
34+
Our computational strategy to accomplish this involves first reusing the _C. elegans_ connectome and the 3D anatomical map of the _C. elegans_ nervous system and body plan. We have used the NeuroML standard (Gleeson et al., 2010) to describe the 3D anatomical map of the _C. elegans_ nervous system. This has been done by discretizing each neuron into multiple compartments, while preserving its three-dimensional position and structure. We have then defined the connections between the NeuroML neurons using the _C. elegans_ connectome. Because NeuroML has a well-defined mapping into a system of Hodgkin-Huxley equations, it is currently possible to import the "spatial connectome" into the NEURON simulator (Hines & Carnevale 1997) to perform in silico experiments.
3535

3636
### Previous accomplishments
3737

38-
- Building the *C. elegans* NeuroML file
38+
- Building the _C. elegans_ NeuroML file
3939

4040
### Current roadmap
4141

4242
###[Updated NeuroML connectome model](https://github.com/openworm/OpenWorm/issues?milestone=15&state=open)
4343

44-
The [NeuroML connectome model](https://github.com/openworm/CElegansNeuroML) provides a framework for [multi-compartmental modeling](https://en.wikipedia.org/wiki/Multi-compartment_model) of the *C. elegans* nervous system. We are continuing to refine this to include more and more information that is known about the anatomy and dynamics of the nervous system in order to reach ever-improving biological realism.
44+
The [NeuroML connectome model](https://github.com/openworm/CElegansNeuroML) provides a framework for [multi-compartmental modeling](https://en.wikipedia.org/wiki/Multi-compartment_model) of the _C. elegans_ nervous system. We are continuing to refine this to include more and more information that is known about the anatomy and dynamics of the nervous system in order to reach ever-improving biological realism.
4545

4646
- [Create sample NeuroML connectome output](https://github.com/openworm/OpenWorm/issues/114)
4747
- [Remove Glutamate\_GJ etc in neuroConstruct project](https://github.com/openworm/OpenWorm/issues/50)
48-
- [Create or reuse a NeuroML description of c. elegans motor neuron synapses](https://github.com/openworm/OpenWorm/issues/124)
48+
- [Create or reuse a NeuroML description of _C. elegans_ motor neuron synapses](https://github.com/openworm/OpenWorm/issues/124)
4949

5050
### Issues list
5151

@@ -56,9 +56,9 @@ All issues related to [working with data](https://github.com/openworm/OpenWorm/i
5656

5757
Repository | Description | Language
5858
------------ | ------------- | ------------
59-
<a href="https://github.com/openworm/CElegansNeuroML">CElegansNeuroML</a> | NeuroML based C. elegans model, contained in a neuroConstruct project | Java
59+
<a href="https://github.com/openworm/CElegansNeuroML">CElegansNeuroML</a> | NeuroML based <em>C. elegans<em> model, contained in a neuroConstruct project | Java
6060
<a href="https://github.com/openworm/Blender2NeuroML">Blender2NeuroML</a> | Conversion script to bring neuron models drawn in Blender into NeuroML format | Python
61-
<a href="https://github.com/openworm/NEURONSimData">NEURONSimData</a> | Graphing voltage data from NEURON sims of C. elegans conectome | Python
61+
<a href="https://github.com/openworm/neuronal-analysis/tree/master/NEURONSimData">NEURONSimData</a> | Graphing voltage data from NEURON sims of <em>C. elegans<em> conectome | Python
6262
<a href="https://github.com/openworm/OWMeta">OWMeta</a> | Metadata extraction, translation, storage, and sharing | Python
6363

6464

@@ -76,7 +76,7 @@ With the ever increasing capacity to collect data about biological system, the n
7676

7777
### Current roadmap
7878

79-
- [Create a D3 implementation of the C. elegans connectome HivePlot](https://github.com/openworm/OpenWorm/issues/89)
79+
- [Create a D3 implementation of the _C. elegans_ connectome HivePlot](https://github.com/openworm/OpenWorm/issues/89)
8080

8181
### Issues list
8282

@@ -86,6 +86,5 @@ All issues related to [working with data](https://github.com/openworm/OpenWorm/i
8686

8787
Repository | Description | Language
8888
------------ | ------------- | ------------
89-
<a href="https://github.com/openworm/wormbrowser">wormbrowser</a> | The Worm Browser -- a 3D browser of the cellular anatomy of the c. elegans | Javascript
89+
<a href="https://github.com/openworm/wormbrowser">wormbrowser</a> | The Worm Browser -- a 3D browser of the cellular anatomy of the <em>c. elegans<em> | Javascript
9090
<a href="https://github.com/openworm/openwormbrowser-ios">openwormbrowser-ios</a> | OpenWorm Browser for iOS, based on the open-3d-viewer, which was based on Google Body Browser | Objective-C
91-
<a href="https://github.com/openworm/data-viz">data-viz</a> | Repository for scripts and other code items to create web-based visualizations of data in the project | Python

docs/Projects/geppetto.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ In order to allow the world to play with the model easily, we are engineering [G
55

66
Geppetto, is written in Java and leverages technologies like [OSGi](http://www.osgi.org/), [Spring Framework](http://www.springsource.org/spring-framework), [OpenCL](http://www.khronos.org/opencl/) and [Maven](http://maven.apache.org/).
77

8-
Geppetto's frontend is written using [THREE.js](http://mrdoob.github.com/three.js/) and [WebGL](http://www.khronos.org/webgl/). Back-end / front-end communication happens via [JSON](http://www.json.org/) messages through [WebSocket](http://www.websocket.org/).
8+
Geppetto's frontend is written using [THREE.js](https://github.com/mrdoob/three.js) and [WebGL](http://www.khronos.org/webgl/). Back-end / front-end communication happens via [JSON](http://www.json.org/) messages through [WebSocket](http://www.websocket.org/).
99

1010
The engine runs on on Eclipse Virgo WebServer deployed on an Amazon [Elastic Compute Cloud](http://aws.amazon.com/ec2/) Linux instance.
1111

docs/Projects/muscle-neuron-integration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Muscle-Neuron-Channel Integration
44
High-level Overview
55
-------------------
66

7-
The fidelity of OpenWorm to its biological counterpart, *C. elegans*, depends on the realism of its constituent parts, such as computationally-modelled cells. The internal dynamics of these cells are largely controlled by ion channels, so a biophysically-informed ion channel model will, in-turn, support a realistic model of the entire organism.
7+
The fidelity of OpenWorm to its biological counterpart, _C. elegans_, depends on the realism of its constituent parts, such as computationally-modelled cells. The internal dynamics of these cells are largely controlled by ion channels, so a biophysically-informed ion channel model will, in-turn, support a realistic model of the entire organism.
88

9-
Broadly speaking, the team for this project will develop a workflow and tools to simulate *C. elegans* cell dynamics using simulated ion channel (*intracellular*) dynamics.
9+
Broadly speaking, the team for this project will develop a workflow and tools to simulate _C. elegans_ cell dynamics using simulated ion channel (*intracellular*) dynamics.
1010

1111
[![image](http://docs.google.com/drawings/d/1WzHYpgHZBDvbAxIb-KDDw0OatI8KWXQ8h_BeMVaQ2wM/pub?w=1238&amp;h=869)](https://docs.google.com/drawings/d/1WzHYpgHZBDvbAxIb-KDDw0OatI8KWXQ8h_BeMVaQ2wM/edit)
1212

@@ -63,7 +63,7 @@ ChannelWorm
6363

6464
[The ChannelWorm subproject](https://github.com/VahidGh/ChannelWorm/) is, at a high level, a pipeline to convert ion channel *data* found in scientific papers into ion channel *models*. This pipeline involves:
6565

66-
1. [Identification](https://github.com/VahidGh/ChannelWorm/issues/10/) of papers with ion channel data.
66+
1. [Identification](https://github.com/VahidGh/ChannelWorm/issues/) of papers with ion channel data.
6767
2. Extraction of data from these papers, including figures, active parameters and tabular data.
6868
3. [Digitization](http://channelworm.readthedocs.org/en/latest/digitization/) of figures, and more generally, converting this information into machine-readable form.
6969

@@ -129,7 +129,7 @@ Issues for OWMeta are tracked [on Github](https://github.com/openworm/OWMeta/iss
129129
Muscle Model
130130
------------
131131

132-
The [muscle model subproject](https://github.com/openworm/muscle_model/) is concerned with modelling and simulation at the *cellular* level, specifically attempting to simulate the electrical dynamics of a *C. elegans* body wall muscle cell.
132+
The [muscle model subproject](https://github.com/openworm/muscle_model/) is concerned with modelling and simulation at the *cellular* level, specifically attempting to simulate the electrical dynamics of a _C. elegans_ body wall muscle cell.
133133

134134
This depends on what happens in [ChannelWorm](#channelworm), since ion channel dynamics are integral to our simulation of membrane dynamics.
135135

@@ -176,7 +176,7 @@ Issues for the muscle model are tracked [on Github.](https://github.com/openworm
176176
c302
177177
----
178178

179-
The [c302 subproject](https://github.com/openworm/CElegansNeuroML/tree/master/CElegans/pythonScripts/c302/) is an effort to simulate the connectome of *C. elegans*, which includes its 302 neurons. The neural dynamics will start out with biologically-unrealistic integrate and fire cells, and be replaced with incrementally more realistic dynamics, as tests pass. Like the musclemodel, dynamics of neurons depend on ion channel dynamics within the cells, and thus depend on the channelworm subproject.
179+
The [c302 subproject](https://github.com/openworm/CElegansNeuroML/tree/master/CElegans/pythonScripts/c302/) is an effort to simulate the connectome of _C. elegans_, which includes its 302 neurons. The neural dynamics will start out with biologically-unrealistic integrate and fire cells, and be replaced with incrementally more realistic dynamics, as tests pass. Like the musclemodel, dynamics of neurons depend on ion channel dynamics within the cells, and thus depend on the channelworm subproject.
180180

181181
### Previous accomplishments
182182

0 commit comments

Comments
 (0)