Arthor Documentation for Future Developer: Difference between revisions

From DISI
Jump to navigation Jump to search
 
(65 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Introduction ==
== Introduction ==
[https://www.nextmovesoftware.com/downloads/arthor/documentation/Arthor.pdf Here is the link to Arthor's manual]
[https://www.nextmovesoftware.com/downloads/arthor/documentation/Arthor.pdf Here is the link to Arthor's manual]
* Username: ucsf@nextmovesoftware.com
* Password: <Ask jjiteam@googlegroups.com>


Arthor configurations and the frontend files are consolidated in '''/nfs/soft2/arthor_configs/'''.
Arthor configurations and the frontend files are consolidated in '''/nfs/soft2/arthor_configs/'''.
Line 14: Line 16:
#* Username: ucsf@nextmovesoftware.com
#* Username: ucsf@nextmovesoftware.com
#* Password: <Ask jjiteam@googlegroups.com>
#* Password: <Ask jjiteam@googlegroups.com>
# Go to releases. Look for the right OS and copy the link address.
# Go to releases. Look for ''' smallworld-java-<version>.tar.gz ''' and copy the link address.
# Download using wget
# Download using wget
#: <source> wget --user ucsf@nextmovesoftware.com --password <Ask jjiteam@googlegroups.com> <link address> </source>
#: <source> wget --user ucsf@nextmovesoftware.com --password <Ask jjiteam@googlegroups.com> <link address> </source>
Line 21: Line 23:


== How To Launch Arthor For The First Time ==
== How To Launch Arthor For The First Time ==
=== Prepare Files and Directories ===
# Ssh to nfs-exc and become root
# Ssh to nfs-exc and become root
# Open a port in the firewall
# Open a port in the firewall
Line 40: Line 43:
Resolver=https://sw.docking.org/util/smi2mol?smi=%s
Resolver=https://sw.docking.org/util/smi2mol?smi=%s
</source>
</source>
=== Start Arthor Instance ===
# Now ssh into a machine you wish to run an Arthor instance on and become root
# Now ssh into a machine you wish to run an Arthor instance on and become root
# Change your shell to bash if you havn't already
# Change your shell to bash if you havn't already
Line 48: Line 52:
#: <source>export ARTHOR_CONFIG="/nfs/soft2/arthor_configs/arthor-<version>/<name_of_config_file>.cfg"</source>
#: <source>export ARTHOR_CONFIG="/nfs/soft2/arthor_configs/arthor-<version>/<name_of_config_file>.cfg"</source>
# Launch java
# Launch java
#: <source>java -jar /nfs/soft2/arthor_configs/arthor-<version>/arthor-<version>-centos7/java/arthor.jar --httpPort=<port_number></source>
#: <source>java -jar -Dserver.port=<port_number> /nfs/soft2/arthor_configs/arthor-<version>/arthor-server-<version>.war</source>


=== Configuration Details ===
=== Configuration Details ===
Line 67: Line 71:


== How to Build Arthor Databases==
== How to Build Arthor Databases==
We can build Arthor Databases anywhere.
We can build Arthor Databases anywhere. Consolidate smiles into one directory so you can index them all one by one.


Just use the script located at '''/nfs/home/jjg/scripts/arthor_index_script.sh'''
Just use the script located at '''/nfs/home/jjg/scripts/arthor_index_script.sh''' at the directory where you stored the smiles.


Here is the content of the script:
Here is the content of the script:
Line 75: Line 79:
#!/bin/bash
#!/bin/bash


version="3.4.2"
target="*.smi"
threads='48'
version="3.6.1"


# EXPORT THESE FIRST
 
export ARTHOR_DIR=/nfs/soft2/arthor_configs/arthor-$version/arthor-$version-centos7/
export ARTHOR_DIR=/nfs/soft2/arthor_configs/arthor-$version/arthor-$version-centos8/
export PATH=$ARTHOR_DIR/bin/:$PATH
export PATH=$ARTHOR_DIR/bin/:$PATH


target="*.smi"
for j in $target
do
        echo 'smi2atdb -v -r -j '$threads' -p '$j' '${j}'.atdb |& tee -a '${j}'_log'
        time smi2atdb -v -r -j $threads -p $j ${j}.atdb |& tee -a ${j}_log
echo 'smi2atfp -j '$threads' -p '$j' '${j}.atfp' |& tee -a '${j}'_log'
        time smi2atfp -j $threads -p $j ${j}.atfp |& tee -a ${j}_log
done


for j in $target
for i in $target*atdb
do
do
        echo 'smi2atdb -j 4 -p '$j' '${j}'.atdb'
echo 'atdb2fp -j '$threads' '$i
         smi2atdb -j 4 -p $j ${j}.atdb
         time atdb2fp -j $threads $i
        echo 'atdb2fp -j 4 '$j'.atdb'
chmod 744 $i.fp
atdb2fp -j 4 ${j}.atdb
done
done
</source>
</source>
Line 94: Line 105:
=== Command Details ===
=== Command Details ===
'''smi2atdb''' creates the atdb files needed for Substructure searching.
'''smi2atdb''' creates the atdb files needed for Substructure searching.
*'''-v''' verbose
*'''-r''' Compute and store ring size information in the index allowing ring size (3-10) expressions ([r6] and [Z5])
*'''-j''' is the amount of threads to use to index the smiles file
*'''-j''' is the amount of threads to use to index the smiles file
*'''-p''' stores the position of the original file  
*'''-p''' stores the position of the original file  
'''atdb2fp''' makes substructure searching faster
'''atdb2fp''' makes substructure searching faster
'''smi2atfp''' creates atfp files for similarity searching


==Setting up Round Table==
==Setting up Round Table==
Line 129: Line 144:
{| class="wikitable"
{| class="wikitable"
|-
|-
! CentOS 7 Machine
! Rocky Linux Machine
! Port
! Port
! Round Table Data Directory
! Round Table Data Directory
! Which Arthor
|-
|-
| samekh
| arthor
| 10.20.0.41:8000
| 10.20.200.100:8080
| /local2/public_arthor/
| /local3/public_arthor/
|-
| Public Arthor
| nun
| 10.20.0.40:8000
| /local2/public_arthor/
|-
|-
|}
|}


===Arthor Round Table Head===
===Private Arthor===
{| class="wikitable"
{| class="wikitable"
|-
|-
! CentOS 7 Machine
! Rocky Linux Machine
! Port
! Port
! Round Table Data Directory
! Round Table Data Directory
! Which Arthor
|-
|-
| samekh
| arthor
| 10.20.0.41:8080
| 10.20.200.100:8081
| /local2/arthor_database/
| /local3/private_arthor/
|-
| Private Arthor
| nun
| 10.20.0.40:8080
| /local2/arthor_database/
|-
|-
|}
|}


===Arthor Round Table Nodes===
===Super Private Arthor===
{| class="wikitable"
{| class="wikitable"
|-
|-
Line 166: Line 177:
! Port
! Port
! Round Table Data Directory
! Round Table Data Directory
! Which Arthor
|-
| nun
| 10.20.0.40:8080
| Round table head has no directory
| Super Private Arthor Round Table Head Node
|-
| nun
| 10.20.0.40:8008
| /local2/public_arthor/
| Super Private Arthor Database Node
|-
|-
| samekh
| samekh
| 10.20.0.41:8008
| 10.20.0.41:8008
| /local2/arthor_database/
| /local2/public_arthor/
| Super Private Arthor Database Node
|-
|}
 
===Arthor BB and CC===
{| class="wikitable"
|-
|-
| nun
! CentOS 7 Machine
| 10.20.0.40:8008
! Port
| /local2/arthor_database/
! Data Directory
! Which Arthor
|-
|-
| nfs-exd
| epyc-A40
| 10.20.1.113:8008
| 10.20.200.92:8081
| /export/exd/arthor_database/
| /local2/arthorbb
| ArthorBB
|-
|-
| nfs-exh
| epyc-A40
| 10.20.5.19:8008
| 10.20.200.92:8082
| /export/exh/arthor_database/
| /local2/arthorcc
| ArthorCC
|-
|-
|}
|}


== Customizing Arthor Frontend to our needs ==
== Customizing Arthor Frontend To Our Needs (Arthor 3.6.1) ==
The frontend Arthor code is located at '''/nfs/exc/arthor_configs/*''' and the '''*''' is based on current running version.
'''These instructions only worked and compiled for me in the machine called epyc which is running Rocky 8 Linux operating system.'''
=== Add Arthor Download Options ===
==== For Arthor 3.4: ====
1. vim .extract/webapps/ROOT/WEB-INF/static/index.html


2. search: '''arthor_tsv_link'''
Summary of changes in index.html:
*Add contact info
*Advertise TLDR
*Remove button for Formula
*Database Information Link


3. in the div with the class=”dropdown-content”, add these link options and change the number accordingly:
Summary of changes in index.js:
*Hyperlink the results to zinc20


              <a id="arthor_tsv_link" href="#"> TSV-500</a>
Summary of changes in sketcher.js:
              <a id="arthor_tsv_link_5000" href="#"> TSV-5,000</a>
*Input box should be updated as user draws molecule
              <a id="arthor_tsv_link_50000" href="#"> TSV-50,000</a>
 
              <a id="arthor_tsv_link_100000" href="#"> TSV-100,000</a>
Summary of changes in arthor-swagger.yaml.js:
              <a id="arthor_tsv_link_max" href="#"> TSV-max</a>
*Input box should be updated as user draws molecule
              <a id="arthor_csv_link" href="#"> CSV-500</a>
 
              <a id="arthor_csv_link_5000" href="#"> CSV-5,000</a>
 
              <a id="arthor_csv_link_50000" href="#"> CSV-50,000</a>
=== Install Prerequisite Packages ===
              <a id="arthor_csv_link_100000" href="#"> CSV-100,000</a>
# Install Apache Maven
              <a id="arthor_csv_link_max" href="#"> CSV-max</a>
#* <source>dnf install maven -y</source>
              <a id="arthor_sdf_link" href="#"> SDF-500</a>
# Install Node Package Manager (NPM)
              <a id="arthor_sdf_link_5000" href="#"> SDF-5,000</a>
#* <source>dnf install npm -y</source>
              <a id="arthor_sdf_link_50000" href="#"> SDF-50,000</a>
# In your home directory, create a new directory to hold the files for the upcoming procedures
              <a id="arthor_sdf_link_100000" href="#"> SDF-100,000</a>
#* <source>mkdir /mnt/nfs/home/jjg/arthor_build_from_source</source>
              <a id="arthor_sdf_link_max" href="#"> SDF-max</a>
# Download these latest Arthors and store them in 'arthor_build_from_source/'. [[Arthor Documentation for Future Developer#How To Download Arthor|Here's how to download Arthor.]]
#* arthor-3.6.1-source.tar.gz
#* arthor-3.6.1-centos7.tar.gz
# Extract contents from the tar.gz files
#* <source>tar -xvf arthor-3.6.1-source.tar.gz
tar -xvf arthor-3.6.1-centos7.tar.gz</source>
# Install Apache Maven Arthor dependencies through this script
#* <source>
#!/bin/bash
 
export ARTHOR_DIR=/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1-centos8/java
export OS=linux
export VERSION=3.6.1
 
mvn install:install-file -Dfile=$ARTHOR_DIR/arthor-jni-${OS}.jar \
                        -Dpackaging=jar \
                        -DgeneratePom=true \
                        -DartifactId=arthor-jni-${OS} \
                        -DgroupId=com.nextmovesoftware.arthor \
                        -Dversion=$VERSION
mvn install:install-file -Dfile=$ARTHOR_DIR/arthor-jni.jar \
                        -Dpackaging=jar \
                        -DgeneratePom=true \
                        -DartifactId=arthor-jni \
                        -DgroupId=com.nextmovesoftware.arthor \
                        -Dversion=$VERSION
</source>
=== Customizing Index.html ===
Location: /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1/arthor-3.6.1-source/server/src/main/webapp/WEB-INF/static/index.html
 
==== Add contact info and tldr ====
# vim /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1/arthor-3.6.1-source/server/src/main/webapp/WEB-INF/static/index.html
# Search for 'arthor_table_list'
#* <source>?arthor_table_list</source>
# Add contact info, a plug to tldr.docking.org, and database link after the div block where arthor_table_list is inside of. It should look like this
#* <source>
      <div class="opt-box-border">
        <label>Databases</label>
        <!-- This will be populated by available databases -->
        <ul id="arthor_table_list">
          <li class="placeholder">Please select a search type</li>
        </ul>
      </div>
      <div class="opt-box-border">
        <label>Ask Questions</label>
        Email us: jjiteam@googlegroups.com
      </div>
      <div class="opt-box-border">
        <label> To Download 100K+ Results</label>
        Sign up for <a href="http://tldr.docking.org/">tldr.docking.org</a> and use arthorbatch
      </div>
      <div class="opt-box-border">
        <label> Database Information</label>
        <a href="https://wiki.docking.org/index.php/Smallworld_and_Arthor_Databases#Smallworld_Databases" target="_blank">Database Information Link</a>
      </div>
</source>
 
==== Add Database Information Link ====
 
 
==== Remove Similarity and Formula Buttons ====
# vim /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1/arthor-3.6.1-source/server/src/main/webapp/WEB-INF/static/index.html
# Search for 'arthor_search_list'
#* <source> ?arthor_search_list </source>
# Delete and Replace the whole 'ul' element block with this
#* <source>
          <li value="Similarity" onclick="setSearchType(this)" class="first">
            Similarity
          </li><li value="Substructure" onclick="setSearchType(this)">
            Substructure
          </li><li value="SMARTS" onclick="setSearchType(this)" class="last">
            SMARTS
          </li>
          <!--<li value="Formula" onclick="setSearchType(this)" class="last">
            Formula
          </li>-->
</source>
 
=== Customize Index.js ===
Location /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1-source/server-ui/src/index.js
 
# Add the zinc20 hyperlink to the Arthor results. Search for this
#* <source>
"<b>" + id + "</b>"
</source>
# Delete the contents of the whole else block and replace it with this
#* <source>
            if (id.substring(0, 6) == "ZINC00") {
                $info.append(
                  $('<tr>').append(
                    $('<td>').append("<b><a target='_blank' href='https://zinc20.docking.org/substances/"+id+"'>" + id + "</a></b>",
                                    "<span class='table_name'>" + table_name + "</span>")));
            } else if (id.substring(0,4) == "ZINC" && id.substring(4,6) != "00") {
                $info.append(
                  $('<tr>').append(
                    $('<td>').append("<b><a target='_blank' href='https://cartblanche22.docking.org/substance/"+id+"'>" + id + "</a></b>",
                                    "<span class='table_name'>" + table_name + "</span>")));
            } else {
                $info.append(
                  $('<tr>').append(
                    $('<td>').append("<b>" + id + "</b>")));
            }
</source>


4. then vim .extract/webapps/ROOT/WEB-INF/static/js/index.js
=== Customize Sketcher.js ===
Location: /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1-source/server-ui/src/sketcher.js


5. search: '''function $(t){'''
==== Input Box Updates as User Draws ====
#vim /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1-source/server-ui/src/sketcher.js
#Search for this line "var smiles = event.src.smiles();"
#* <source>?var smiles = event.src.smiles();</source>
#Add this new line below it
#* <source>$('#ar_text_input').val(smiles);</source>


6. in the function $(t), add these lines:
=== Customize arthor-swagger.yaml ===
Location: /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1/arthor-3.6.1-source/server/src/main/webapp/WEB-INF/static/swagger/arthor-swagger.yaml


if(document.getElementById("arthor_tsv_link")) {
==== Change URL Base Path for API Call ====
        var e=i.a.param({query:s.b.query,type:s.b.type,draw:0,start:0,length:t,flags:s.b.flags}),n=s.b.url+"/dt/"+E(s.b.table)+"/search";i()("#arthor_sdf_link").attr("href",n+".sdf?"+e),i() ("#arthor_tsv_link").attr("href",n+".tsv?"+e),i()("#arthor_csv_link").attr("href",n+".csv?"+e)
# vim /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1/arthor-3.6.1-source/server/src/main/webapp/WEB-INF/static/swagger/arthor-swagger.yaml
}
# Search for "servers"
if (document.getElementById("arthor_tsv_link_5000")) {
#* <source>?basePath</source>
        var e=i.a.param({query:s.b.query,type:s.b.type,draw:0,start:0,length:5000,flags:s.b.flags}),n=s.b.url+"/dt/"+E(s.b.table)+"/search";i()("#arthor_sdf_link_5000").attr("href",n+".sdf?"+e),i()("#arthor_tsv_link_5000").attr("href",n+".tsv?"+e),i()("#arthor_csv_link_5000").attr("href",n+".csv?"+e)
# Remove "/arthor" and keep argument empty
}
if (document.getElementById("arthor_tsv_link_50000")) {
        var e=i.a.param({query:s.b.query,type:s.b.type,draw:0,start:0,length:50000,flags:s.b.flags}),n=s.b.url+"/dt/"+E(s.b.table)+"/search";i()("#arthor_sdf_link_50000").attr("href",n+".sdf?"+e),i()("#arthor_tsv_link_50000").attr("href",n+".tsv?"+e),i()("#arthor_csv_link_50000").attr("href",n+".csv?"+e)
}
if (document.getElementById("arthor_tsv_link_100000")) {
        var e=i.a.param({query:s.b.query,type:s.b.type,draw:0,start:0,length:100000,flags:s.b.flags}),n=s.b.url+"/dt/"+E(s.b.table)+"/search";i()("#arthor_sdf_link_100000").attr("href",n+".sdf?"+e),i()("#arthor_tsv_link_100000").attr("href",n+".tsv?"+e),i()("#arthor_csv_link_100000").attr("href",n+".csv?"+e)
}
if (document.getElementById("arthor_tsv_link_max")) {
        var e=i.a.param({query:s.b.query,type:s.b.type,draw:0,start:0,length:1000000000,flags:s.b.flags}),n=s.b.url+"/dt/"+E(s.b.table)+"/search";i()("#arthor_sdf_link_max").attr("href",n+".sdf?"+e),i()("#arthor_tsv_link_max").attr("href",n+".tsv?"+e),i()("#arthor_csv_link_max").attr("href",n+".csv?"+e)
}


=== Take out Similarity Button ===
=== Compile/Minify Code through NPM ===
vim .extract/webapps/ROOT/WEB-INF/static/index.html
# Install NPM packages and Minify Code
search: '''Similarity'''
#* <source>
Comment out this line '''< li value="Similarity" onclick="setSearchType(this)" class="first"> Similarity </li >''' //added spaces at the beginning and end so prevent wiki from converting it
cd /nfs/home/jjg/arthor_build_from_source/arthor-3.6.1/arthor-3.6.1-source/server-ui
Then add "first" in Substructure's class
npm install
=== Hyperlink to zinc20 ===
npx webpack-dev-server
vim .extract/webapps/ROOT/WEB-INF/static/js/index.js
npx webpack --mode=production
search: '''table_name'''
</source>
*find this line "< b>" + d + "< /b>"
# If the npx commands don't work, try updating node and npm version to the latest one.
*replace with '''"< b><a target='_blank' href='https://zinc20.docking.org/substances/"+d+"'>" + d + "</a></b >"''' //added spaces at the beginning and end so prevent wiki from converting it
# Build the war file
#* <source>
cd /nfs/home/jjg/arthor_build_from_source/arthor-3.6.1/arthor-3.6.1-source/server
mvn install -Pbootable
</source>
# If it works, then the path to new war file is at /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.4.7/arthor-3.4.7-source/server/target/arthor-server-3.4.7.war


=== Make Input Box Work ===
== Adding Arthor to Systemd (example) ==
At the end of the Arthor config file add this:
# Create service files
    Resolver=https://sw.docking.org/util/smi2mol?smi=%s
#: <source>
To copy smiles in the input box:
touch /etc/systemd/system/arthor.service
    vim .extract/webapps/ROOT/WEB-INF/static/js/index.js
</source>
    search this: “var e=t.src.smiles()”
# Add this code block in the service file
    add this after the semi-colon
#: <source>
        document.getElementById("ar_text_input").value = e;


== Restarting Arthor Instance(s) Instructions ==
[Unit]
Public, Private, and SuperPrivate Arthors are all started the same way.
Description=Arthor Public Instance
After=network.target


Public Arthor lives and runs on both '''samekh''' and '''nun'''.
[Service]
Type=exec
Restart=always
RestartSec=3
User=root
ExecStart=/usr/bin/bash /nfs/soft2/arthor_configs/start_arthor_service.sh -public
ExecStop=/bin/kill -15 $MAINPID


Private Arthor lives and runs on '''samekh'''.
[Install]
WantedBy=multi-user.target
</source>
# Change "ExecStart" to other Arthor Instances


Super Private Arthor lives and runs on '''nun'''.
== Restarting Arthor Instance(s) Instructions ==
=== Public and Private Arthor ===
# ssh to "arthor" server and run
#: <source>
systemctl <start|stop|restart> <arthor|arthorp>
</source>


=== Instructions ===
=== ArthorBB, ArthorCC, and ArthorCovalent ===
* To start an instance
# ssh to "epyc-a40" server and run
# ssh into appropriate machine
#: <source>
# become root
systemctl <start|stop|restart> <arthorbb|arthorcc|arthorcovalent>
# cat run_arthors_on_reboot.sh
</source>
# copy and run screen command
#* Public Arthor only needs one line.
#** /usr/bin/screen -dmS public_arthor /root/screen_public_arthor.sh
#* Private and Super Private needs two lines.
#** /usr/bin/screen -dmS private_arthor /root/screen_private_arthor.sh
#** /usr/bin/screen -dmS private_arthor_rt_head /root/screen_private_round_table_head.sh


* To stop an instance
=== Super Private Arthor ===
# ssh into appropriate machine
# Ssh to machine with respective Arthor instance and become root
# become root
# execute '''run_arthors_on_reboot.sh''' to show restart all instances on the machine
# One Way
#: <source>
#* screen -ls
bash /root/run_arthors_on_reboot.sh
#* screen -r <instance_screen_name or instance_screen_number>
</source>
#* ctrl + C
# execute '''start_arthor_script.sh''' to restart specific Arthor instance. It will show you options to choose from.
# Second Way
#: <source>
#* screen -ls, find instance name or number
bash /nfs/soft2/arthor_configs/start_arthor_script.sh
#* screen -X -S <instance_screen_name or instance_screen_number> kill
</source>
#* screen -ls, to double check

Latest revision as of 22:22, 19 March 2024

Introduction

Here is the link to Arthor's manual

  • Username: ucsf@nextmovesoftware.com
  • Password: <Ask jjiteam@googlegroups.com>

Arthor configurations and the frontend files are consolidated in /nfs/soft2/arthor_configs/.

/nfs/soft2/arthor_configs/start_arthor_script.sh can start/restart Arthor instances on respective machines.

Launch the script to see the options available.

How To Download Arthor

  1. Ssh to nfs-soft2 and become root. Prepare directory
     mkdir /export/soft2/arthor_configs/arthor-<version> && cd /export/soft2/arthor_configs/arthor-<version>
  2. Download Software with this link
    • Username: ucsf@nextmovesoftware.com
    • Password: <Ask jjiteam@googlegroups.com>
  3. Go to releases. Look for smallworld-java-<version>.tar.gz and copy the link address.
  4. Download using wget
     wget --user ucsf@nextmovesoftware.com --password <Ask jjiteam@googlegroups.com> <link address>
  5. Decompress the file
    •  tar -xvf <file_name>

How To Launch Arthor For The First Time

Prepare Files and Directories

  1. Ssh to nfs-exc and become root
  2. Open a port in the firewall
    firewall-cmd --permanent --add-port=<port_number>/tcp 
    firewall-cmd --reload
  3. Go to Arthor Config directory
    cd /export/soft2/arthor_configs/arthor-<latest_version>
  4. Create an Arthor config file
    vim <name_of_file>.cfg
    • Add these lines in the file. Check the manual for more options.
    DataDir=/local2/public_arthor
    MaxConcurrentSearches=6
    MaxThreadsPerSearch=8
    AutomaticIndex=false
    AsyncHitCountMax=20000
    Depiction=./depict/bot/svg?w=%w&h=%h&svgunits=px&smi=%s&zoom=0.8&sma=%m&smalim=1
    Resolver=https://sw.docking.org/util/smi2mol?smi=%s

Start Arthor Instance

  1. Now ssh into a machine you wish to run an Arthor instance on and become root
  2. Change your shell to bash if you havn't already
    bash
  3. Create a screen
    screen -S <screen_name>
  4. Prepare Arthor Config Path
    export ARTHOR_CONFIG="/nfs/soft2/arthor_configs/arthor-<version>/<name_of_config_file>.cfg"
  5. Launch java
    java -jar -Dserver.port=<port_number> /nfs/soft2/arthor_configs/arthor-<version>/arthor-server-<version>.war

Configuration Details

  • DataDir: This is the directory where the Arthor data files live. Location where the index files will be created and loaded from.
  • MaxConcurrentSearches: Controls the maximum number of searches that can be run concurrently by setting the database pool size. When switching between a large number of databases it can be useful to have a larger pool size, the only trade off is keeping file pointers open.
  • MaxThreadsPerSearch: The number of threads to use for both ATDB and ATFP searches
  • Set AutomaticIndex to false if you don't want new smiles files added to the data directory to be indexed automatically
  • AsyncHitCountMax: The upper-bound for the number of hits to retrieve in background searches.
  • Resolver: Using Smallworld API, allows input box to take in a SMILE format and automatically draw on the board.

Check Arthor manual for more configuration options

How to Build Arthor Databases

We can build Arthor Databases anywhere. Consolidate smiles into one directory so you can index them all one by one.

Just use the script located at /nfs/home/jjg/scripts/arthor_index_script.sh at the directory where you stored the smiles.

Here is the content of the script:

#!/bin/bash

target="*.smi"
threads='48'
version="3.6.1"


export ARTHOR_DIR=/nfs/soft2/arthor_configs/arthor-$version/arthor-$version-centos8/
export PATH=$ARTHOR_DIR/bin/:$PATH

for j in $target
do
        echo 'smi2atdb -v -r -j '$threads' -p '$j' '${j}'.atdb |& tee -a '${j}'_log'
        time smi2atdb -v -r -j $threads -p $j ${j}.atdb |& tee -a ${j}_log
	echo 'smi2atfp -j '$threads' -p '$j' '${j}.atfp' |& tee -a '${j}'_log'
        time smi2atfp -j $threads -p $j ${j}.atfp |& tee -a ${j}_log
done

for i in $target*atdb
do
	echo 'atdb2fp -j '$threads' '$i
        time atdb2fp -j $threads $i
	chmod 744 $i.fp
done

Command Details

smi2atdb creates the atdb files needed for Substructure searching.

  • -v verbose
  • -r Compute and store ring size information in the index allowing ring size (3-10) expressions ([r6] and [Z5])
  • -j is the amount of threads to use to index the smiles file
  • -p stores the position of the original file

atdb2fp makes substructure searching faster

smi2atfp creates atfp files for similarity searching

Setting up Round Table

"Round Table allows you to serve and split chemical searches across multiple host machines. The implementation provides a lightweight proxy that forwards requests to other Arthor host servers that do the actual search. Communication is done using the existing Web APIs.

Setting up Host Server

  1. Ssh to nfs-soft2 and become root
  2. Open a port in the firewall
    firewall-cmd --permanent --add-port=<port_number>/tcp 
    firewall-cmd --reload
  3. Go to Arthor Config Directory
    cd /export/soft2/arthor_configs/arthor-<version>
  4. Create Round Table Head configuration file. Here is an example:
  5. [RoundTable]
    RemoteClient=http://10.20.0.41:8008
    RemoteClient=http://10.20.5.19:8008
    Resolver=https://sw.docking.org/util/smi2mol?smi=%s
  6. Now ssh into a machine you wish to run the round table head on and become root
  7. Change your shell to bash if you havn't already
    bash
  8. Create a screen
    screen -S <screen_name>
  9. Prepare Arthor Config Path
    export ARTHOR_CONFIG="/nfs/soft2/arthor_configs/arthor-<version>/<round_table_head>.cfg"
  10. Launch java
    java -jar /nfs/soft2/arthor_configs/arthor-<version>/arthor-<version>-centos7/java/arthor.jar --httpPort=<port_number>

Active Arthor Instances

Public Arthor

Rocky Linux Machine Port Round Table Data Directory Which Arthor
arthor 10.20.200.100:8080 /local3/public_arthor/ Public Arthor

Private Arthor

Rocky Linux Machine Port Round Table Data Directory Which Arthor
arthor 10.20.200.100:8081 /local3/private_arthor/ Private Arthor

Super Private Arthor

CentOS 7 Machine Port Round Table Data Directory Which Arthor
nun 10.20.0.40:8080 Round table head has no directory Super Private Arthor Round Table Head Node
nun 10.20.0.40:8008 /local2/public_arthor/ Super Private Arthor Database Node
samekh 10.20.0.41:8008 /local2/public_arthor/ Super Private Arthor Database Node

Arthor BB and CC

CentOS 7 Machine Port Data Directory Which Arthor
epyc-A40 10.20.200.92:8081 /local2/arthorbb ArthorBB
epyc-A40 10.20.200.92:8082 /local2/arthorcc ArthorCC

Customizing Arthor Frontend To Our Needs (Arthor 3.6.1)

These instructions only worked and compiled for me in the machine called epyc which is running Rocky 8 Linux operating system.

Summary of changes in index.html:

  • Add contact info
  • Advertise TLDR
  • Remove button for Formula
  • Database Information Link

Summary of changes in index.js:

  • Hyperlink the results to zinc20

Summary of changes in sketcher.js:

  • Input box should be updated as user draws molecule

Summary of changes in arthor-swagger.yaml.js:

  • Input box should be updated as user draws molecule


Install Prerequisite Packages

  1. Install Apache Maven
    • dnf install maven -y
  2. Install Node Package Manager (NPM)
    • dnf install npm -y
  3. In your home directory, create a new directory to hold the files for the upcoming procedures
    • mkdir /mnt/nfs/home/jjg/arthor_build_from_source
  4. Download these latest Arthors and store them in 'arthor_build_from_source/'. Here's how to download Arthor.
    • arthor-3.6.1-source.tar.gz
    • arthor-3.6.1-centos7.tar.gz
  5. Extract contents from the tar.gz files
    • tar -xvf arthor-3.6.1-source.tar.gz
      tar -xvf arthor-3.6.1-centos7.tar.gz
  6. Install Apache Maven Arthor dependencies through this script
    • #!/bin/bash
      
      export ARTHOR_DIR=/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1-centos8/java
      export OS=linux
      export VERSION=3.6.1
      
      mvn install:install-file -Dfile=$ARTHOR_DIR/arthor-jni-${OS}.jar \
                               -Dpackaging=jar \
                               -DgeneratePom=true \
                               -DartifactId=arthor-jni-${OS} \
                               -DgroupId=com.nextmovesoftware.arthor \
                               -Dversion=$VERSION
      mvn install:install-file -Dfile=$ARTHOR_DIR/arthor-jni.jar \
                               -Dpackaging=jar \
                               -DgeneratePom=true \
                               -DartifactId=arthor-jni \
                               -DgroupId=com.nextmovesoftware.arthor \
                               -Dversion=$VERSION

Customizing Index.html

Location: /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1/arthor-3.6.1-source/server/src/main/webapp/WEB-INF/static/index.html

Add contact info and tldr

  1. vim /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1/arthor-3.6.1-source/server/src/main/webapp/WEB-INF/static/index.html
  2. Search for 'arthor_table_list'
    • ?arthor_table_list
  3. Add contact info, a plug to tldr.docking.org, and database link after the div block where arthor_table_list is inside of. It should look like this
    •       <div class="opt-box-border">
              <label>Databases</label>
              <!-- This will be populated by available databases -->
              <ul id="arthor_table_list">
                <li class="placeholder">Please select a search type</li>
              </ul>
            </div>
            <div class="opt-box-border">
              <label>Ask Questions</label>
              Email us: jjiteam@googlegroups.com
            </div>
            <div class="opt-box-border">
              <label> To Download 100K+ Results</label>
              Sign up for <a href="http://tldr.docking.org/">tldr.docking.org</a> and use arthorbatch
            </div>
            <div class="opt-box-border">
              <label> Database Information</label>
              <a href="https://wiki.docking.org/index.php/Smallworld_and_Arthor_Databases#Smallworld_Databases" target="_blank">Database Information Link</a>
            </div>

Add Database Information Link

Remove Similarity and Formula Buttons

  1. vim /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1/arthor-3.6.1-source/server/src/main/webapp/WEB-INF/static/index.html
  2. Search for 'arthor_search_list'
    •  ?arthor_search_list
  3. Delete and Replace the whole 'ul' element block with this
    •           <li value="Similarity" onclick="setSearchType(this)" class="first">
                  Similarity
                </li><li value="Substructure" onclick="setSearchType(this)">
                  Substructure
                </li><li value="SMARTS" onclick="setSearchType(this)" class="last">
                  SMARTS
                </li>
                <!--<li value="Formula" onclick="setSearchType(this)" class="last">
                  Formula
                </li>-->

Customize Index.js

Location /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1-source/server-ui/src/index.js

  1. Add the zinc20 hyperlink to the Arthor results. Search for this
    • "<b>" + id + "</b>"
  2. Delete the contents of the whole else block and replace it with this
    •             if (id.substring(0, 6) == "ZINC00") {
                      $info.append(
                        $('<tr>').append(
                          $('<td>').append("<b><a target='_blank' href='https://zinc20.docking.org/substances/"+id+"'>" + id + "</a></b>",
                                           "<span class='table_name'>" + table_name + "</span>")));
                  } else if (id.substring(0,4) == "ZINC" && id.substring(4,6) != "00") {
                      $info.append(
                        $('<tr>').append(
                          $('<td>').append("<b><a target='_blank' href='https://cartblanche22.docking.org/substance/"+id+"'>" + id + "</a></b>",
                                           "<span class='table_name'>" + table_name + "</span>")));
                  } else {
                      $info.append(
                        $('<tr>').append(
                          $('<td>').append("<b>" + id + "</b>")));
                  }

Customize Sketcher.js

Location: /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1-source/server-ui/src/sketcher.js

Input Box Updates as User Draws

  1. vim /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1-source/server-ui/src/sketcher.js
  2. Search for this line "var smiles = event.src.smiles();"
    • ?var smiles = event.src.smiles();
  3. Add this new line below it
    • $('#ar_text_input').val(smiles);

Customize arthor-swagger.yaml

Location: /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1/arthor-3.6.1-source/server/src/main/webapp/WEB-INF/static/swagger/arthor-swagger.yaml

Change URL Base Path for API Call

  1. vim /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.6.1/arthor-3.6.1-source/server/src/main/webapp/WEB-INF/static/swagger/arthor-swagger.yaml
  2. Search for "servers"
    • ?basePath
  3. Remove "/arthor" and keep argument empty

Compile/Minify Code through NPM

  1. Install NPM packages and Minify Code
    • cd /nfs/home/jjg/arthor_build_from_source/arthor-3.6.1/arthor-3.6.1-source/server-ui
      npm install
      npx webpack-dev-server
      npx webpack --mode=production
  2. If the npx commands don't work, try updating node and npm version to the latest one.
  3. Build the war file
    • cd /nfs/home/jjg/arthor_build_from_source/arthor-3.6.1/arthor-3.6.1-source/server
      mvn install -Pbootable
  4. If it works, then the path to new war file is at /mnt/nfs/home/jjg/arthor_build_from_source/arthor-3.4.7/arthor-3.4.7-source/server/target/arthor-server-3.4.7.war

Adding Arthor to Systemd (example)

  1. Create service files
    touch /etc/systemd/system/arthor.service
  2. Add this code block in the service file
    [Unit]
    Description=Arthor Public Instance
    After=network.target
    
    [Service]
    Type=exec
    Restart=always
    RestartSec=3
    User=root
    ExecStart=/usr/bin/bash /nfs/soft2/arthor_configs/start_arthor_service.sh -public
    ExecStop=/bin/kill -15 $MAINPID
    
    [Install]
    WantedBy=multi-user.target
  3. Change "ExecStart" to other Arthor Instances

Restarting Arthor Instance(s) Instructions

Public and Private Arthor

  1. ssh to "arthor" server and run
    systemctl <start|stop|restart> <arthor|arthorp>

ArthorBB, ArthorCC, and ArthorCovalent

  1. ssh to "epyc-a40" server and run
    systemctl <start|stop|restart> <arthorbb|arthorcc|arthorcovalent>

Super Private Arthor

  1. Ssh to machine with respective Arthor instance and become root
  2. execute run_arthors_on_reboot.sh to show restart all instances on the machine
    bash /root/run_arthors_on_reboot.sh
  3. execute start_arthor_script.sh to restart specific Arthor instance. It will show you options to choose from.
    bash /nfs/soft2/arthor_configs/start_arthor_script.sh