Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions CITATION.bib
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
@misc{BiochemicalVisualization.jl,
author = {Andreas Hildebrandt <andreas.hildebrandt@uni-mainz.de> and contributors},
title = {BiochemicalVisualization.jl},
url = {https://github.com/hildebrandtlab/BiochemicalVisualization.jl},
version = {v0.1.0},
year = {2022},
month = {12}
@article{BiochemicalAlgorithms.jl,
author = {Jennifer Leclaire and Thomas Kemmer and Andreas Hildebrandt},
title = {Structure-based bioinformatics with BiochemicalAlgorithms.jl},
journal = {Proceedings of the JuliaCon Conferences},
publisher = {The Open Journal},
volume = {7},
number = {78},
pages = {188},
year = {2025},
doi = {10.21105/jcon.00188},
url = {https://doi.org/10.21105/jcon.00188}
}
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@

BiochemicalVisualization is the graphical interface for [BiochemicalAlgorithms.jl](https://github.com/hildebrandtlab/BiochemicalAlgorithms.jl), providing different representations for biomolecular systems. All representations can be visualized in the form of interactive web widgets that are embeddable in Jypyter notebooks.

# Installation
## Installation
To install BiochemicalVisualization, open a Julia REPL, switch to the package mode by pressing `]`, and type


```julia
pkg> add BiochemicalVisualization
```

# Usage
## Usage
```julia
using BiochemicalAlgorithms, BiochemicalVisualization

Expand All @@ -31,6 +31,11 @@ ball_and_stick(sys)
```
![Ball-and-stick representation of a simple molecule](https://raw.githubusercontent.com/hildebrandtlab/BiochemicalVisualization.jl/develop/docs/src/tutorials/gfx/ball-and-stick.png)

# Contributing
## Contributing
You have ideas for improvements, criticism, or ran into problems? You are looking for a feature that you know from BALL?
Feedback and contributions are very welcome. Check out our [guidelines](CONTRIBUTING.md) and use our [issue tracker](https://github.com/hildebrandtlab/BiochemicalVisualization.jl/issues) or contact us [via e-mail](mailto:hildebrandtlab@uni-mainz.de?subject=BiochemicalVisualization.jl).

## Citing
If you use BiochemicalVisualization.jl in your research, please cite the following publication:
> Leclaire et al., (2025). Structure-based bioinformatics with BiochemicalAlgorithms.jl.
> Proceedings of the JuliaCon Conferences, 7(78), 188, <https://doi.org/10.21105/jcon.00188>
Loading