en:interaktive_musikanalyse

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
en:interaktive_musikanalyse [2022/01/05 12:01]
sebastiane [Settings]
en:interaktive_musikanalyse [2023/08/22 10:43] (aktuell)
martin [How To Install, Start and Use I-MaT]
Zeile 1: Zeile 1:
-===== Interactive Music Analysis Tool (I-MaT) =====+===== The Interactive Music Analysis Tool (I-MaT) =====
  
-The modular program //Interactive Music Analysis Tool (I-MaT)// produces visualizations of and statistical analyses of sheet music files. The basic idea is to choose between the various options listed by entering //yes//-//no// or numbers (//1, 2, 3 //etc.). The //music21// commands on which the program is based are not visible to the user.+The modular program //Interactive Music Analysis Tool (I-MaT)// produces visualizations and statistical analyses of sheet music files. The basic idea is to choose between the various menu options listed by entering corresponding index numbers (//1, 2, 3 //etc.). The //music21/////MidiTok// commands on which the program is based are not visible to the user.
  
-Results can be achieved quickly by navigating through simple dialog windows and the selection from the options displayed. The results (visualizations, diagrams, transformed sheet music files, CSV files) are displayed in external programs (//MuseScore//, //matplotlib//), in which they can then be further processed or exported.+Results can be achieved quickly by navigating through simple dialog windows and the selection from the options displayed. The results (visualizations, diagrams, transformed sheet music files, CSV files) can be displayed within I-MaT as well as exported in order to be opened in external programs (//MuseScore//, //PSPP/SPSS//), in which they can then be further processed.
  
 Programm code: Sebastian Oliver Eck Programm code: Sebastian Oliver Eck
  
-==== Download and installation ====+==== Documentation and User Guides ====
  
-It is necessary to [[en:installation|install]] Anaconda or Miniconda including the current version of the HfM environment hfm_x.x.x.yml (currently: [[https://analyse.hfm-weimar.de/scripts/hfm_1.1.2.yml|hfm_1.1.2.yml]]; see: [[en:jupyter-anaconda|installation and Setup]]) and [[en:installation#musescore| MuseScore]].+I-MaT is an innovative tool designed to facilitate in-depth musical analysis through an easy-to-use interface. I-MaT offers a comprehensive set of functionalities allowing for the examination of musical pieces from a wide range of perspectivesThe documentation (available on [[https://i-mat.readthedocs.io/en/latest/|readthedocs.io]]) serves as a comprehensive guide, aiming to provide you with insights into I-MaT's functionalities and its modular concept, and assist both first-time users and experienced researchers in using the tool effectively.
  
 +The sections contained within the documentation provide detailed information on how to use the Interactive Music Analysis Tool, from [[https://i-mat.readthedocs.io/en/latest/getting_started.html|downloading and the installation]], to [[https://i-mat.readthedocs.io/en/latest/contribute.html|contribution and code extension]], to its application in music analysis. Furthermore, you will find a detailed descriptions of I-MaT's [[https://i-mat.readthedocs.io/en/latest/module_files/src.html|source code]], explaining the different packages' and modules' content that make up the tool.
  
-=== Downloading the program ===+This documentation provides you with the necessary knowledge to navigate I-MaT, explore its features, and conduct your own analyses by using the tool!
  
-Please download the Python script (//right clicksave link as//). +==== How To InstallStart and Use I-MaT ====
-If possible, save this on your desktop (Windows/Mac): +
-   * [[https://analyse.hfm-weimar.de/jupyter/I-MaT-InteraktivesMusikanalyse-Tool.py|Download link]]+
  
 +===Installation===
  
-=== Starting the program ===+//First//, please, open the Command Prompt/Terminal in Windows/Mac by executing the following steps:
  
 +**Windows**
  
-== 1. Opening the Anaconda Powershell Prompt (anaconda3) / Anaconda Prompt (anaconda3) ==+There are several ways to access the Command Prompt in Windows, here's one:
  
 +  * Press the ''Windows key + R'' to open the Run dialog box.
 +  * In the Run dialog box, type ''cmd'' and then press ''Enter''. This will open the Command Prompt window.
  
 +**macOS**
  
-Open the //Anaconda Powershell Prompt/Anaconda Prompt//. You can find this in your Windows start menu under:+There are several ways to access the Terminal in macOS, here are two:
  
-   Start > Anaconda 3 (64-bit) > Anaconda Powershell Prompt (anaconda3) bzwAnaconda Prompt (anaconda3)+  * Open ''Finder''
 +  * Navigate to the ''Applications'' folder, then go to ''Utilities''
 +  * Locate and double-click on ''Terminal'' to open it.
  
-On Mac you will find the //Anaconda Powershell Prompt/Anaconda Prompt// in the 'Finder'.+Alternatively:
  
-== Alternative: Open the Anaconda Powershell Prompt (hfm_1.x.x)/Anaconda Prompt (hfm_1.x.x) ==+  * Press ''Command + Space'' to bring up ''Spotlight'', 
 +  * type ''terminal'', and hit Enter.
  
-Alternativelyon Windows you may be able to choose one of the following two options:+//Second//please, install the Interactive Music Analysis Tool (I-MaT). Do this by typing the following line into the Command Prompt/Terminal window:
  
-   Start Anaconda 3 (64-bit) Anaconda Powershell Prompt (hfm_1.x.x) bzw. Anaconda Prompt (hfm_1.x.x)+<code> 
 +pip install imat 
 +</code>
  
-In this case you can skip //2Activation of the project-specific Python environment// and continue directly with //3. Starting the program//.+Note: The installation is necessary only onceAfter successfully installing I-MaT, start the tool by following the steps below.
  
 +MuseScore Installation:
  
-== 2. Activation of the project-specific Python environment ==+**Attention:** Users who want to use all functions of I-MaT must necessarily install a notation program, such as the free program MuseScore.
  
 +The installation of MuseScore is free of charge and is therefore **strongly recommended**. MuseScore can be directly downloaded from [[https://musescore.org/en]].
  
 +===Starting I-MaT===
  
-When opening the //Anaconda Powershell Prompt/Anaconda Prompt// you will see the following line:+To run the tool, simply type the following command into your Command Prompt/Terminal window:
  
-   (base) C:\Users\Username>+<code> 
 +imat 
 +</code>
  
-Then enter //'conda activate hfm_1.x.x'//After that //press Enter//:+After starting I-MaT, the following menu will be displayed within your console:
  
-   (base) C:\Users\Username>conda activate hfm_1.x.x+<code> 
 +I-MaT - Interactive Music Analysis Tool, v3.2.1, (2023). Project: "Computer-Assisted Music Analysis"
  
-Note: Instead of //'1.x.x'// please enter the respective version number (see above)!+Department of Musicology Weimar-Jena, University of Music Franz Liszt Weimar, Germany
  
-The content of the bracket preceding the line should now have changed as follows:+MIT License, Copyright (c) 2023 S.O. Eck.
  
-   (hfm_1.x.x) C:\Users\Username>+----------------------------------------------------------------------
  
-If you now see an error message, jump to the menu "//Troubleshooting//" below.+LOCATION: Start Menu
  
 +Please make a selection from the options below by entering the entry index number:
  
 +No.       Menu item                                           <Explanation>
  
-== 3. Starting the program ==+1         PROG: Analysis of one sheet music file              <Analysis of a single piece of music> 
 +2         CONV: Conversion of multiple music files            <Conversion of multiple music files within one folder> 
 +        TOKE: Tokenisation of multiple music files          <Tokenisation of multiple music files within one folder> 
 +4         CONF: Update Software Paths and Preferences         <Update or redefine paths to essential software and user preferences>
  
 +Which menu item should be executed? (<No. of menu item>):
 +</code>
 +Figure 1: The Interactive Music Analysis Tool (I-MaT) - Start Menu (version 3.2.1)
  
 +Using the program is relatively straight-forward - the program's text-based command line interface (CLI) allows you to choose from a list of menu entries by entering the corresponding entry index number (s. Figure 1). All further steps are self-explanatory. Enjoy!
  
-Now enter // 'python' // and drag the icon of the program file +==== Notes and Support ====
-//'I-MaT - Interaktives Musikanalyse-Tool.py'// into the prompt window. The file path is now automatically copied into the window. //press enter//:+
  
-   (hfm_1.x.x) C:\Users\Username>python "[Pfad/]I-MaT - Interaktives Musikanalyse-Tool.py"+**Warning:** When starting I-MaT for the first time, in the most cases you have to configure the //music21// settings so that you can download music files from the Internet as well as display music files within a music editor (i.e., //MuseScore//).
  
-Note: Pay attention to entering the double quotation marks!+You will be guided through this entire process by I-MaT.
  
-Example: with the program file saved on the desktop (Windows):+   4 CONFUpdate Software Paths and Preferences
  
-   (hfm_1.x.x) C:\Users\Username>python "C:\Users\Username\Desktop\I-MaT - Interaktives Musikanalyse-Tool.py"+The settings can later be adjusted by choosing the menu entries shown above within I-MaT's start menu.
  
 +If all of the above was too fast, don't worry!
  
-The program starts after few seconds!+You can find detailed User Guide for how to install and start I-MaT in the Online Documentation's [[https://i-mat.readthedocs.io/en/latest/getting_started.html|Getting Started with I-MaT]] section.
  
 +If you have any difficulties with using the program or if you have any questions or suggestions on how to further improve I-MaT's functionalities, please contact the author, Sebastian Oliver Eck (<imat.inquiries@gmail.com>).
  
 +==== I-MaT: Features and Accessibility ====
  
-=== Troubleshooting ===+Addressing the steep learning curve often encountered with Python-based music analysis tools like Music21 or CAMAT, the Interactive Music Analysis Tool (I-MaT) was designed specifically with user accessibility in mind. I-MaT utilizes a new and innovative approach to access, work with and implement various python libraries, such as, but not limited to, music21 or MidiTok for textual music analysis, within one unified, user friendly text-based command-line-interface (CLI).
  
 +I-MaT allows users to quickly obtain results by navigating through simple dynamic menu structures and selecting methods and tools from predefined options (see Figure 1). The tool uses an accessible and easily extendable text-based CLI, with the underlying Music21 and MidiTok commands remaining invisible to the user. While requiring minimal familiarity with command-line environments, the preference for a CLI over a GUI offers a compromise between user-friendliness and easy code extendibility.
  
 +This compromise was necessary to keep the barrier to entry as low as possible, and to encourage a broad usage and user-based participation in the tool's ongoing development via [[https://github.com/sebastian-eck/I-MaT|GitHub]]. To further increase accessibility, I-MaT was distributed via [[https://pypi.org/project/imat/|Pypi.org]], allowing for an easy installation via integrated package-management systems such as the commonly used python pip installer. I-MaT’s source code is complemented by an extensive [[https://i-mat.readthedocs.io/en/latest/|online documentation]] that offers guidance to both users as well as contributors.
  
-If you enter the command:+While virtually encompassing all the functionalities of the integrated python packages for music information retrieval/tokenization, i.e., music21/MidiTok, I-MaTs functionalities are currently limited to a representative, yet well-tested set of statistical analysis, export, visualization, transformation and musical data tokenization tools.
  
-   (base) C:\Users\Username>conda activate hfm_1.x.x+With all those benefits at hand, I-MaT is a very flexible and powerful tool that could cater to the needs of a diverse range of users, from novice music analysts to advanced researchers.
  
-and receive an error message, either the project-specific Python environment '//hfm_1.x.x//' is not installed correctly, or you have entered the wrong version number. To check which project-specific Python environments are installed, enter the following command at the //Anaconda Powershell Prompt/Anaconda Prompt// and //press Enter//:+==== Education and Training ====
  
-   (base) C:\Users\Username>conda info --envs+In addition to its analytical capabilities, I-MaT serves as an effective didactic tool, further bridging the gap between musicology and the broader field of computer-assisted analysis and Music Information Retrieval (MIR).
  
-The following list shows the project-specific Python environments installed on your computer.+I-MaT’s various functionalities could provide valuable support for music and musicology courses at both high school and university levels. Its user-friendly interface and simple installation make it an ideal tool for students to quickly obtain results and explore various analytical approaches using computational methods, allowing them to gain a deeper understanding of the musical works they are studying.
  
-   # conda environments: +Furthermore, I-MaT’s modular design opens possibilities for launching educational projects centered around musicological programming, with the added advantage of seamlessly integrating their outcomes and functions into I-MaT through collaborative platforms like GitHub.
-   # +
-   base                  *  C:\Users\Username\anaconda3 +
-   hfm_1.0.0                C:\Users\Username\anaconda3\envs\hfm_1.0.0+
  
-If the current version of //'hfm_1.x.x'// is missing here, install the project-specific Python environments by following the //installation instructions// under [[en:installation_windows|Windows]][[en:installation_mac|Mac]] or [[en:installation_linux|Linux]] in menu item // 2. Project-specific Python environment//.+By using I-MaTstudents can develop valuable analytical skills that are useful not only in musicology but also in other areas of the humanities where data-driven methods are becoming increasingly important.
  
 +The Interactive Music Analysis Tool, I-MaT, should be seen as a contribution to Computational Musicology or Digital Musicology within the Digital Humanities.
  
 +==== External Links/Sources ====
  
-==== Using the program ====+[[https://jadh2023.nijl.ac.jp/home|JADH2023]]: 12th annual conference of the Japanese Association for Digital Humanities (JADH), \\ 
 +“//Possibilities for Data-Driven Humanities//”, National Institute of Japanese Literature (online), 20.9. - 22.9. 2023, \\ 
 +Presentation of Sebastian Oliver Eck: //Interactive Music Analysis Tool (I-MaT)//
  
 +Online-Dokumentation (readthedocs.io): https://i-mat.readthedocs.io/en/latest/
  
-The program is self-explanatoryWhat you have to do next is in front of the blinking cursor. If there are several options, they are displayed in a list from which you can select an option by entering a number.+GitHub Repositoryhttps://github.com/sebastian-eck/I-MaT
  
-When using it for the first time, you must also configure certain //music21// settings, if you have not already done this for the Jupyter notebooks. When the program starts, you will be guided through the configuration of your //music21// settings file. +PyPi Repositoryhttps://pypi.org/project/imat/
- +
-See[[en:interaktive_musikanalyse#settings|Settings]]  +
- +
-Then please select: +
-      PROG: Analysis of a single piece of music +
- +
-After you have loaded a sheet music file, you come to the so-called main menu, which in its rough structure corresponds to the structure of the //Jupyter-Notebooks Basics//: +
- +
-      FILE: Menu selection                                              <Basic functions> +
-      TOOL: Menu selection (statistical analysis)                       <Selection of various statistical analysis tools> +
-      TOOL: Menu selection (visualisation)                              <Selection of different visualisation tools> +
-      TOOL: Menu selection (pattern search)                             <Selection of different tools for pattern search> +
-      SETT: Settings                                                    <Settings in the music21 environment file/language settings> +
-      HELP: Project overview                                            <Information about the project "Computer-Aided Music Analysis"> +
-      EXIT: Exit program                                                <Exits the Python script> +
- +
-All further steps are self-explanatory. Enjoy! +
- +
- +
-====Settings==== +
- +
-When using it for the first time, you have to configure the //music21// settings so that you can download music files from the Internet and your music editor (//MuseScore3//) opens for displaying the music - if you have not already done this for the Jupyter notebooks or you are not guided through the configuration anyway when you start the program for the first time. To do this, select: +
-   2 SETT: Settings +
- +
-If you select the following option: +
-   3 ENVT: Einstellungen neu konfigurieren +
- +
-you will first be asked to delete the existing settings file. Agree to that. You will then be given the option to reconfigure the settings file. You have to have the local path to your sheet music editor (e.g. MuseScore3.exe) as well as to your folder for the exported graphics, sheet music files and tables ready.+
  • en/interaktive_musikanalyse.1641384110.txt.gz
  • Zuletzt geändert: 2022/01/05 12:01
  • von sebastiane