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
21 changes: 20 additions & 1 deletion .JuliaFormatter.toml
Original file line number Diff line number Diff line change
@@ -1 +1,20 @@
style = "blue"
style = "blue"
indent = 4
margin = 92
always_for_in = true
whitespace_typedefs = true
whitespace_ops_in_indices = true
remove_extra_newlines = true
import_to_using = false
pipe_to_function_call = false
short_to_long_function_def = false
always_use_return = false
whitespace_in_kwargs = true
annotate_untyped_fields_with_any = true
format_docstrings = true
align_struct_field = false
align_conditional = false
align_assignment = false
align_pair_arrow = false
conditional_to_if = false
normalize_line_endings = "unix"
5 changes: 5 additions & 0 deletions .github/workflows/TagBot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ on:
types:
- created
workflow_dispatch:
inputs:
lookback:
default: "3"
jobs:
TagBot:
if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
Expand All @@ -12,4 +15,6 @@ jobs:
- uses: JuliaRegistries/TagBot@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
# Edit the following line to reflect the actual name of the GitHub Secret containing your private key
ssh: ${{ secrets.DOCUMENTER_KEY }}
# ssh: ${{ secrets.NAME_OF_MY_SSH_PRIVATE_KEY_SECRET }}
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
<img align="right" width="230" src="assets/logo.png" />

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://moleculehub.github.io/OpenBabel.jl/dev/)
[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/JuliaDiff/BlueStyle)
[![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
Expand Down
Binary file removed assets/logo.png
Binary file not shown.
122 changes: 95 additions & 27 deletions docs/src/api/energy.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,62 @@

These macros perform energy calculations, geometry optimizations, and advanced molecular computations.

## Energy Calculations
## Calculate Energy

```@docs
@calculate_energy
@minimize_energy
@add_partial_charges
```

## Structure Generation
### Usage Examples

```@docs
@canonicalize
@generate_conformers
Calculate energy using different force fields:

```julia
# MMFF94 forcefield (default)
@chain begin
@read_file("molecules.smi", "smi")
@gen_3D_coords("fast")
@calculate_energy("MMFF94")
@output_as("energies.sdf", "sdf")
@execute
end

# UFF forcefield
@chain begin
@read_file("molecules.smi", "smi")
@gen_3D_coords("med")
@calculate_energy("UFF")
@output_as("uff_energies.sdf", "sdf")
@execute
end
```

## Usage Examples
Energy ranking workflow:

### Energy Minimization Workflow
```julia
@chain begin
@read_file("conformers.sdf", "sdf")
@calculate_energy("MMFF94")
@sort_by("Energy") # Sort by ascending energy (most stable first)
@output_as("energy_ranked.sdf", "sdf")
@execute
end
```

## Minimize Energy

Optimize molecular geometries using different forcefields:
```@docs
@minimize_energy
```

### Usage Examples

```julia
# MMFF94 forcefield (default)
@chain begin
@read_file("molecules.smi", "smi")
@gen_3D_coords("fast")
@minimize_energy("MMFF94")
@calculate_energy("MMFF94")
@output_as("optimized.sdf", "sdf")
@execute
end
Expand All @@ -44,19 +72,26 @@ end
end
```

### Available Forcefields
Complete energy minimization workflow:

| Forcefield | Description | Best for |
|------------|-------------|----------|
| `MMFF94` | Merck Molecular Force Field | General organic molecules |
| `MMFF94s` | MMFF94 static | Static conformations |
| `UFF` | Universal Force Field | Broad chemical space |
| `GAFF` | General AMBER Force Field | Drug-like molecules |
| `Ghemical` | Ghemical Force Field | Quick calculations |
```julia
@chain begin
@read_file("molecules.smi", "smi")
@gen_3D_coords("fast")
@minimize_energy("MMFF94")
@calculate_energy("MMFF94")
@output_as("optimized.sdf", "sdf")
@execute
end
```

### Partial Charge Calculation
## Add Partial Charges

Add partial charges using different methods:
```@docs
@add_partial_charges
```

### Usage Examples

```julia
# Gasteiger charges (default)
Expand All @@ -78,7 +113,7 @@ end
end
```

### Available Charge Methods
Available charge methods:

| Method | Description | Accuracy | Speed |
|--------|-------------|----------|-------|
Expand All @@ -88,7 +123,32 @@ end
| `eqeq` | EQEq charges | Medium | Fast |
| `eem` | Electronegativity Equalization | Medium | Medium |

### Conformer Generation
## Canonicalize

```@docs
@canonicalize
```

### Usage Examples

Standardize molecular representation:

```julia
@chain begin
@read_file("compounds.smi", "smi")
@canonicalize()
@output_as("canonical_structures.smi", "smi")
@execute
end
```

## Generate Conformers

```@docs
@generate_conformers
```

### Usage Examples

Generate multiple conformations:

Expand All @@ -103,9 +163,19 @@ Generate multiple conformations:
end
```

### Complete Energy Workflow
## Available Forcefields

Comprehensive energy calculation pipeline:
| Forcefield | Description | Best for |
|------------|-------------|----------|
| `MMFF94` | Merck Molecular Force Field | General organic molecules |
| `MMFF94s` | MMFF94 static | Static conformations |
| `UFF` | Universal Force Field | Broad chemical space |
| `GAFF` | General AMBER Force Field | Drug-like molecules |
| `Ghemical` | Ghemical Force Field | Quick calculations |

## Complete Workflows

### Comprehensive Energy Calculation Pipeline

```julia
@chain begin
Expand All @@ -124,8 +194,6 @@ end

### Drug Discovery Pipeline

Typical computational chemistry workflow for drug discovery:

```julia
@chain begin
@read_file("drug_candidates.smi", "smi")
Expand Down
Loading
Loading