Difference between revisions of "Massmine"

From UFRC
Jump to navigation Jump to search
(Created page with "Category:Software {|<!--CONFIGURATION: REQUIRED--> |{{#vardefine:app|MassMine}} |{{#vardefine:url|http://www.massmine.org/}} <!--CONFIGURATION: OPTIONAL (|1}} means it's O...")
 
m (Text replacement - "/ufrc" to "/blue")
 
(22 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
[[Category:Software]]
 
[[Category:Software]]
{|<!--CONFIGURATION: REQUIRED-->
+
== Using MassMine on Research Computing ==
|{{#vardefine:app|MassMine}}
+
[http://www.massmine.org MassMine], and a data filtering program called [https://github.com/n3mo/jsan jsan] (the '''J'''SON '''S'''wiss '''A'''rmy k'''N'''ife) are installed on Research Computing.
|{{#vardefine:url|http://www.massmine.org/}}
 
<!--CONFIGURATION: OPTIONAL (|1}} means it's ON)-->
 
|{{#vardefine:conf|}}          <!--CONFIGURATION-->
 
|{{#vardefine:exe|1}}            <!--ADDITIONAL INFO-->
 
|{{#vardefine:pbs|}}            <!--PBS SCRIPTS-->
 
|{{#vardefine:policy|}}        <!--POLICY-->
 
|{{#vardefine:testing|}}      <!--PROFILING-->
 
|{{#vardefine:faq|}}            <!--FAQ-->
 
|{{#vardefine:citation|}}      <!--CITATION-->
 
|{{#vardefine:installation|}} <!--INSTALLATION-->
 
|}
 
<!--BODY-->
 
<!--Description-->
 
{{#if: {{#var: url}}|
 
{{App_Description|app={{#var:app}}|url={{#var:url}}|name={{#var:app}}}}|}}
 
  
MassMine is a social media mining and archiving application that simplifies the process of collecting and managing large amounts of data across multiple sources. It is designed with the researcher in mind, providing a flexible framework for tackling individualized research needs. MassMine is designed to run both on personal computers and dedicated servers/clusters. MassMine handles credential authorizations, data acquisition & archiving, as well as customized data export and analysis.
+
Prior to getting started with MassMine, please read UFRC's [http://wiki.rc.ufl.edu/doc/Getting_Started Getting Started] page and follow the instructions on UFRC's [http://wiki.rc.ufl.edu/doc/FileZilla FileZilla] page. If you do not already have FileZilla installed, please download and install the software by visiting [https://filezilla-project.org/ filezilla-project.org].
  
<!--Modules ##No modules at this time
 
==Required Modules==
 
  
===Serial===
+
(1) Open a terminal and run
* {{#var:app}}
 
===Parallel (OpenMP)===
 
* intel
 
* {{#var:app}}
 
===Parallel (MPI)===
 
* intel
 
* openmpi
 
* {{#var:app}}
 
-->
 
<!-- No system variables at this time
 
==System Variables==
 
* HPC_{{#uppercase:{{#var:app}}}}_DIR - installation directory
 
-->
 
<!--Configuration-->
 
{{#if: {{#var: conf}}|==Configuration==
 
See the [[{{PAGENAME}}_Configuration]] page for {{#var: app}} configuration details.
 
|}}
 
<!--Run-->
 
{{#if: {{#var: exe}}|==Additional Information==
 
  
===Installing MassMine at UF Research Computing===
+
<code>
====You will need:====
+
ssh <YOUR_USERNAME>@hpg.rc.ufl.edu
*UF Research Computing Account: [http://www.rc.ufl.edu/help/account-request/ apply here].
+
</code>
*A [https://twitter.com/ Twitter] account
 
*An SSH client:
 
**Mac: Terminal is installed at /Applications/Utilities/Terminal
 
**Windows: Most users use [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html PuTTY]
 
*An SFTP client:
 
**See our page on [[FileZilla]]
 
====Connecting to Research
 
  
  
 +
(2) MassMine should generally be run a [[Daemons|daemon]] node. This can be done connecting to daemon after logging into HiPerGator:
  
|}}
+
<code>
<!--PBS scripts-->
+
ssh daemon
{{#if: {{#var: pbs}}|==PBS Script Examples==
+
</code>
See the [[{{PAGENAME}}_PBS]] page for {{#var: app}} PBS script examples.
 
|}}
 
<!--Policy-->
 
{{#if: {{#var: policy}}|==Usage Policy==
 
  
WRITE USAGE POLICY HERE (Licensing, usage, access).
 
  
|}}
+
(3) After logging in, MassMine users should change to their /blue directory. Be sure to change <code>groupname</code> and <code>username</code> to your individual username for Research Computing. This username may be different from your UF username. Type the following command into the terminal to change to your scratch directory:
<!--Performance-->
 
{{#if: {{#var: testing}}|==Performance==
 
  
WRITE_PERFORMANCE_TESTING_RESULTS_HERE
+
<code>
 +
cd /blue/groupname/username
 +
</code>
  
|}}
 
<!--Faq-->
 
{{#if: {{#var: faq}}|==FAQ==
 
*'''Q:''' **'''A:'''|}}
 
<!--Citation-->
 
{{#if: {{#var: citation}}|==Citation==
 
If you publish research that uses {{#var:app}} you have to cite it as follows:
 
  
WRITE_CITATION_HERE
+
(4) Before using MassMine, you must load it as a module:
  
|}}
+
<code>
<!--Installation-->
+
module load massmine
{{#if: {{#var: installation}}|==Installation==
+
</code>
See the [[{{PAGENAME}}_Install]] page for {{#var: app}} installation notes.|}}
+
 
<!--Turn the Table of Contents and Edit paragraph links ON/OFF-->
+
 
__NOTOC____NOEDITSECTION__
+
To use an older versions of MassMine add the version number to the end of the command with <code>module load massmine/x.x.x</code>. This will allow you to load a specific version of massmine.
 +
 
 +
After loading MassMine as a module, both <code>massmine</code> and <code>jsan</code> become available for use. You can double check this by checking the version of each program:
 +
 
 +
<code>
 +
massmine --version 
 +
 
 +
jsan --version
 +
</code>
 +
 
 +
For help with using massmine, visit the [http://www.massmine.org official massmine website]. For help with jsan, see the [https://github.com/n3mo/jsan online documentation].

Latest revision as of 19:22, 11 February 2021

Using MassMine on Research Computing

MassMine, and a data filtering program called jsan (the JSON Swiss Army kNife) are installed on Research Computing.

Prior to getting started with MassMine, please read UFRC's Getting Started page and follow the instructions on UFRC's FileZilla page. If you do not already have FileZilla installed, please download and install the software by visiting filezilla-project.org.


(1) Open a terminal and run

ssh <YOUR_USERNAME>@hpg.rc.ufl.edu


(2) MassMine should generally be run a daemon node. This can be done connecting to daemon after logging into HiPerGator:

ssh daemon


(3) After logging in, MassMine users should change to their /blue directory. Be sure to change groupname and username to your individual username for Research Computing. This username may be different from your UF username. Type the following command into the terminal to change to your scratch directory:

cd /blue/groupname/username


(4) Before using MassMine, you must load it as a module:

module load massmine


To use an older versions of MassMine add the version number to the end of the command with module load massmine/x.x.x. This will allow you to load a specific version of massmine.

After loading MassMine as a module, both massmine and jsan become available for use. You can double check this by checking the version of each program:

massmine --version

jsan --version

For help with using massmine, visit the official massmine website. For help with jsan, see the online documentation.