Skip to content

ram8647/tcseg

Repository files navigation

tcseg

Source code for the Tribolium casteneum (Tc) segmentation modeling project on the CompuCell platform.

This project manages the Python source code for a CompuCell modeling project. CompuCell3D is an open-source simulation environment for multi-cell, single-cell-based modeling of tissues, organs and organisms. It uses Cellular Potts Model to model cell behavior. This CompuCell project is funded by the NIH and EPA. Compucell3D is led by Maciej Swat (IU), James Glazier(IU) and Roshan D'Souza (U.Wisc. Milwaukee)

The Tribolium c. modeling project is funded by a grant from the National Science Foundation. It is led by Terri Williams and Ralph Morelli (Trinity College) and Susan Hester (Unversity of Arizona). Student research assistants include:

  • Yuxuan (Effie) Li, Trinity
  • Peter Jung, Trinity
  • Jeremy Fisher, Carleton College

The focus of the project is to create a Monte-Carlo cellular-level model of the process of segmentation in an arthropod.

There are three main source files that make up the Simulation. These are typically found in the /Simulation folder of a CompuCell project. These are the files that will typically be edited and revised during development.

  • Simulation/ElongationModel.py -- initialization file
  • Simulation/ElongationModelSteppable.py -- scripts that define the steps that are performed on each Monte Carlo step.

There are also two main simulation (.cc3d) files. These rarely need editing:

  • tcseg.cc3d
  • tcseg_batch.cc3d

To sync with upstream ram8647/tcseg

  1. $ git fetch upstream
  2. $ git checkout master
  3. $ git merge upstream/master

Standard work flow in Terminal Window

  1. Sync with upstream repo
  2. $ git fetch upstream
  3. $ git checkout master
  4. $ git merge upstream/master
  5. From the master branch create a new work branch and switch to that branch
  6. $ git branch taskname
  7. $ git checkout taskname
  8. Make edits to the files you're going to change, e.g., file/test code/etc
  9. $ git add --all # Add all the changed files to the changeset
  10. $ git commit -m "taskname message" # Commit the changeset, giving it a short message
  11. $ git checkout master # Switch back to the master branch
  12. Sync with upstream again # Same as step 1 (in case others have changed the repo)
  13. $ git merge taskname # Merge the changeset from the taskname branch
  14. $ git push # Push the changes (this pushes to your clone of the main repo)
  15. $ git push upstream # Push the changes to the main repo (assuming you are a collaborator)
  16. $ git branch -d taskname # Optional: Delete your task branch once you're sure your changes are in the repo

Running the simulation

On a Mac, open 'Batch Manager Mac.command'. On a Windows or Linux computer, open a command prompt, cd to the 'BatchManager' directory and run './dist/main_UI'. This will open the Batch Manager, where --most importantly--you can change the params file.

  1. Run Compucell3D (CC3D_3.7.5) by double clicking on CC3D_3.7.5/compucell3d.command
  2. This will open a console and the GUI player
  3. To open a model: File > Open one of the simulation files (.cc3d)
  4. To run it, click on the player's run icon
  5. Debugging runtime comments appear in the console.

There are two options for using the model. You can run 'tcseg.cc3d,' which runs the simulation once; alternately, you can use 'tcseg_batch_.cc3d' to run the simulation multiple times. However, in the latter case, make sure to use a proper params.xml!

Contact Jeremy about how to write a params.xml for running the simulation in batches.

About

Source code for the Tribolium casteneum (Tc) segmentation modeling project on the CompuCell platform.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages