cellulosebuilder.jl

under construction 👷🏽⛏️

https://github.com/cgtbatista/cellulosebuilder.jl

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: wiley.com
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

under construction 👷🏽⛏️

Basic Info
  • Host: GitHub
  • Owner: cgtbatista
  • License: mit
  • Language: Julia
  • Default Branch: main
  • Homepage:
  • Size: 598 KB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

CelluloseBuilder

Stable Dev Build Status Coverage Coverage

A Julia package that reimplements the Cellulose Builder software, aiming to simplify the code and provide more flexibility for dealing with different crystallographic parameters or even newest microfibril models. The package generates cartesian coordinates for a given crystalographic data of the specified structure in XYZ and PDB formats, suitable for using as starting configurations in molecular dynamics simulations and other calculations. The crystaline polymorphs Iα, Iβ, II, and III(I) of practically any size can be constructed, including parallelepipeds, plant cell wall cellulose elementary fibrils of any length, and monolayers. Periodic boundary conditions (PBC) along the crystallographic directions are easily imposed and it can consider covalent bounding through the PBC. The package also generates atom connectivity files in PSF format, required by well-known simulation packages such as NAMD, CHARMM, and others. CelluloseBuilder.jl is written in Julia and should run on any platform that supports Julia and both are freely available.

Original Script Update

The original Cellulose Builder script is written in bash, Perl, and Tcl, requiring additional software like Octave to run on a personal computer (Gomes and Skaf, 2012). There is an online version that is easy to use, however it does not allow adaptations on the source script. Indeed, this julia package still requires the VMD software (psfgen) to work (Humphrey, 1996). Beyond the PSF, other topology formats will be implemented later using TopoTools.

This package, CelluloseBuilder.jl, aims to:

  • Simplify the code
  • Provide more flexibility for dealing with different parameters
  • Implement new features not available in the original version

Documentation

For more information, please check out our stable documentation or dev documentation.

Build Status and Coverage

Check out our build status and code coverage reports.

References

T. C. F. Gomes, M. S. Skaf, J. Comput. Chem. 2012, 33, 1338-1346. 10.1002/jcc.22959.

W. Humphrey, A. Dalke, K. Schulten, J. Mol. Graph. 1996, 14, 33-38. 10.1016/0263-7855(96)00018-5.

Owner

  • Name: Carlos G T Batista
  • Login: cgtbatista
  • Kind: user
  • Location: Campinas, Brazil
  • Company: University of Campinas - Unicamp

PhD Student | Computational Chemistry & MD Simulation

Citation (CITATION.bib)

@article{CelluloseBuilder_2012,
	title = {Cellulose‐Builder: A toolkit for building crystalline structures of cellulose},
	volume = {33},
	url = {https://onlinelibrary.wiley.com/doi/10.1002/jcc.22959},
	doi = {10.1002/jcc.22959},
	number = {14},
	journal = {Journal of Computational Chemistry},
	author = {Gomes, Thiago C. F. and Skaf, Munir S.},
	year = {2012},
	pages = {1338--1346}
}

@misc{CelluloseBuilder.jl,
	author  = {cgtbatista <c203748@dac.unicamp.br> and contributors},
	title   = {CelluloseBuilder.jl},
	url     = {https://github.com/cgtbatista/CelluloseBuilder.jl},
	version = {v1.0.0-DEV},
	year    = {2024},
	month   = {7}
}

GitHub Events

Total
  • Watch event: 3
  • Delete event: 1
  • Push event: 48
  • Pull request event: 2
  • Create event: 1
Last Year
  • Watch event: 3
  • Delete event: 1
  • Push event: 48
  • Pull request event: 2
  • Create event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 months
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 months
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (1)

Dependencies

.github/workflows/CI.yml actions
  • actions/checkout v4 composite
  • codecov/codecov-action v4 composite
  • julia-actions/cache v2 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/julia-docdeploy v1 composite
  • julia-actions/julia-processcoverage v1 composite
  • julia-actions/julia-runtest v1 composite
  • julia-actions/julia-uploadcoveralls v1 composite
  • julia-actions/setup-julia v2 composite
.github/workflows/CompatHelper.yml actions
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite